{"info":{"_postman_id":"529d7119-d1fa-442e-b05f-db159b61cd7b","name":"Ytel API","description":"

Expand your functionality with Inbox, Workflow and our Rest APIs

It's time to build! Connect with customers everywhere they want to engage with you - from text messages, emails, phone calls, and more.

Our world class REST APIs will give you the power to turn your vision into reality.

Documentation around our UI can be found on our Ytel Documentation site.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"489142","collectionId":"529d7119-d1fa-442e-b05f-db159b61cd7b","publishedId":"2s9YRDzAaD","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0371e1"},"publishDate":"2023-10-24T19:12:23.000Z"},"item":[{"name":"CPaaS API","item":[{"name":"Authentication","item":[{"name":"Request a Token","id":"1bb5a22b-36b1-4300-9d63-70cae9ce366b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"captcha\": \"\",\n \"grantType\": \"resource_owner_credentials\",\n \"password\": \"{{password}}\",\n \"refreshToken\": \"\",\n \"username\": \"{{email}}\",\n \"refreshDurationMinutes\": 120\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/auth/v3/token","description":"

Requests a bearer token for making requests to the Ytel API v4.

grantType accepted values:

\"resource_owner_credentials\" or \"refresh_token\"

captcha is for future use and can be ignored.

refreshDurationMinutes is optional and represents the number of minutes for which a refresh token will be valid for.

\n","urlObject":{"protocol":"https","path":["auth","v3","token"],"host":["api","ytel","com"],"query":[],"variable":[]}},"response":[{"id":"c0e16a73-596a-4059-a5d4-65934401514f","name":"Example Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"captcha\": \"\",\n \"grantType\": \"resource_owner_credentials\",\n \"password\": \"{{password}}\",\n \"refreshToken\": \"\",\n \"username\": \"{{email}}\",\n \"refreshDurationMinutes\": 120\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/auth/v3/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1125"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit-Second","value":"25"},{"key":"RateLimit-Limit","value":"25"},{"key":"RateLimit-Remaining","value":"24"},{"key":"RateLimit-Reset","value":"1"},{"key":"X-RateLimit-Remaining-Second","value":"24"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"content-encoding","value":"gzip"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-Kong-Upstream-Latency","value":"109"},{"key":"X-Kong-Proxy-Latency","value":"1"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accessToken\": \"syJ0eXAiOiJ.GciOiJSUzI1NiJ9.eyJzdWIiOiIxNzNjNmY3.J1SGFzaCI6Ijg2Mjc2MTVkYTk1YjYzM2\",\n \"refreshToken\": \"syJ0eXA.GciOiJSUzI1NiJ9.eyJzdWIiOiIxN.WNjdCI6IjE3M2M2ZjdmLWM5MTEtZjgyMy1mYjJkLWw\",\n \"tokenType\": \"Bearer\"\n }\n ]\n}"}],"_postman_id":"1bb5a22b-36b1-4300-9d63-70cae9ce366b"}],"id":"1e77b154-c236-4fb6-8050-14197a292be2","description":"

This API generates a token for the v4 API Endpoints only.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b85aebe2-80b1-4ec1-a376-e2d873c9cfa6"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"67d40927-48a1-4810-b37f-75ac81b6c00a"}}],"_postman_id":"1e77b154-c236-4fb6-8050-14197a292be2"},{"name":"Account Management","item":[{"name":"Get Account","id":"642d129e-9475-4cc1-ae8d-9e1af26c75ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"https://api.ytel.com/ams/v3/accounts","description":"

Retrieves details about the current account.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"https://api.ytel.com/ams/v3/accounts/address/","description":"

Retrieves the physical address of the current account.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"https://api.ytel.com/ams/v3/accounts/subaccounts","description":"

Retrieves details about all of an account's subaccounts.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"domain\": \"\",\n \"name\": \"Apple Lending\",\n \"phone\": \"+1234567899\",\n \"isParentAcct\": false,\n \"parentAcctId\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"source\": \"Customer\",\n \"status\": 1,\n \"id\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/accounts","description":"

Edits the details about an account. This method will replace all editable fields on an account with the provided values.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"inactive\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/accounts/status/:accountId","description":"

Adjust the active/inactive state of a subaccount.

Valid values: active, inactive, and closed.

Generated using the v4 Authentication endpoint.

Some customers like to organize their users under companies. To achieve this a sub-account can be created for a sub-organization and users can be created under that sub-account.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"https://api.ytel.com/ams/v3/accounts/:accountSid","description":"

Deletes a subaccount.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"https://api.ytel.com/ams/v3/accounts/totalFunds","description":"

Retrieves the existing balance for the account. This is only available for parent accounts.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"https://api.ytel.com/ams/v3/accounts/balanceAlert","description":"

Retrieves the existing balance alerts for the account. Balance alerts are events that will fire when balance thresholds are met.

This is only available for parent accounts.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"balanceAlertAmount\": 20.00,\n \"minAlertAmount\": 1.00,\n \"emailAddress\": \"myEmail@mycompany.com\"\n}"},"url":"https://api.ytel.com/ams/v3/accounts/balanceAlert","description":"

Adds a new balance alerts for the account. A balance alert will be sent to the specified email address each time the account's balance drops below the specified threshold.

This is only available for parent accounts.

Account management endpoints allow for viewing data about an account and it's subaccounts.

Account and User management endpoints require a token generated by the Authentication endpoint. A long lived token generated in the UI will not work with these endpoints.

Standard values on an account:

id: Account id. This is a UUID.
\n
name: Name of the account.
\n
emailAddress: Email address of the primary contact for the account.
\n
contactId: Deprecated field.
\n
ytelCompanyId: Deprecated field.
\n
parentAcctId: Account id of this account's parent account. If this account is a parent, it will be the same as id.
\n
isParentAcctId: True if it is a parent account, False if it is a subaccount.
\n
phone: Phone number to use for contacting the account owner.
\n
source: Source of the account.
\n
firstName: First name of the account owner.
\n
lastName: Last name of the account owner.
\n
accountStatus: Whether the account is active or now.
\n

\n","_postman_id":"8f035c0a-f7bd-4340-8647-c951f63556db","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Account Configuration","item":[{"name":"Get Account Configs","id":"e6a3ee44-e311-4e0c-b993-3bd60b435c66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.ytel.com/ams/v3/accounts/config","description":"

Retrieves all account configs for the account.

It will take an optional list of keys if the *keys* parameter is sent. Keys will be comma separated.

Retrieves a single account configs by the name of the key.

Saves a single account config. Note that not all account configs are editable. Attempting to edit a non-editable account config will result in a permission denied error.

Saves multiple account configs at the same time. Note that not all account configs are editable. Attempting to edit a non-editable account config will result in a permission denied error.

Deletes a single account config by name. Note that the account config must be editable.

Retrieves all account configs associated with external services for the account.

Saves a single external account config. The provider and key are required and either the value or encryptedValue are required depending on which key is being sent.

Saves multiple external account configs at the same time.

Deletes all external account configs associated with the specified provider.

Deletes a single external account config specified by provider and key.

The account configuration endpoints allow for reading and writing for various key/value pairs associated with an account. The majority of the account configurations are read-only and cannot be directly manipulated.

External account configurations are used for communicating with external systems. Data for these account configurations need the associated provider, the key, and a value that may be encrypted. Data that is encrypted is stored in an encrypted format and only decrypted when attempting to communicate with the external provider.

\n","_postman_id":"04724429-57f5-4233-b303-6ec4c1dccbaf","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"AI/ML","item":[{"name":"Reword text","id":"a95b47ed-6e10-451d-9a82-1e15475990ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"••••••"}],"body":{"mode":"raw","raw":"{\n \"text\": \"Hello OSCAR TEST 🖐️, this is Jessica with Test Company. Your account is past due. We're here to help! Want to set up a call or share a good time?\",\n \"type\": \"sms\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/ai/reword","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","ai","reword"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a95b47ed-6e10-451d-9a82-1e15475990ff"}],"id":"4624a821-6772-43d9-aa92-9260dd4210f6","_postman_id":"4624a821-6772-43d9-aa92-9260dd4210f6","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Assets","item":[{"name":"Get Assets","id":"29f8f71f-a6f2-40e1-ae49-f3f7ad394d75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/v4/asset/","description":"

Retrieve a list of all assets hosted publicly within the Ytel ecosystem.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","asset",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d54cc3e2-d64a-4cd8-ba6a-eebdc0fbeea9","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":"{{url}}/v4/asset/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"3055","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 10,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"type\": \"audio\",\n \"name\": \"file_example_MP3_700KB.mp3\",\n \"description\": null,\n \"creationDate\": 1617037251215,\n \"modificationDate\": 1617037251215,\n \"status\": 1,\n \"publicUrl\": \"https://client-assets.ytel.com/e77e9ca3-8239-40fe-b43e-4acf065f1700.mp3\",\n \"duration\": 0,\n \"mimeType\": \"audio/mpeg\",\n \"size\": 764176\n },\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"type\": \"audio\",\n \"name\": \"myaudio.wav\",\n \"description\": null,\n \"creationDate\": 1617669481388,\n \"modificationDate\": 1617669481388,\n \"status\": 1,\n \"publicUrl\": \"https://client-assets.ytel.com/644c560c-h732-4618-87b9-849994bb9a09.wav\",\n \"duration\": 16,\n \"mimeType\": \"audio/wave\",\n \"size\": 6459630\n }\n ]\n}"}],"_postman_id":"29f8f71f-a6f2-40e1-ae49-f3f7ad394d75"},{"name":"Get Assets by Type","id":"17622b1a-d302-4c6d-bf87-f9282489bb9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/v4/asset/","description":"

Retrieve a list of all assets hosted publicly within the Ytel ecosystem.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","asset",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0e6b1ee2-96f9-4934-b36c-47301841eef2","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint."}],"url":"{{url}}/v4/asset/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3055"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-RateLimit-Remaining-second","value":"149"},{"key":"X-RateLimit-Limit-second","value":"150"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 10,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"type\": \"audio\",\n \"name\": \"file_example_MP3_700KB.mp3\",\n \"description\": null,\n \"creationDate\": 1617037251215,\n \"modificationDate\": 1617037251215,\n \"status\": 1,\n \"publicUrl\": \"https://client-assets.ytel.com/e77e9ca3-8239-40fe-b43e-4acf065f1700.mp3\",\n \"duration\": 0,\n \"mimeType\": \"audio/mpeg\",\n \"size\": 764176\n },\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"type\": \"audio\",\n \"name\": \"myaudio.wav\",\n \"description\": null,\n \"creationDate\": 1617669481388,\n \"modificationDate\": 1617669481388,\n \"status\": 1,\n \"publicUrl\": \"https://client-assets.ytel.com/644c560c-h732-4618-87b9-849994bb9a09.wav\",\n \"duration\": 16,\n \"mimeType\": \"audio/wave\",\n \"size\": 6459630\n }\n ]\n}"}],"_postman_id":"17622b1a-d302-4c6d-bf87-f9282489bb9a"},{"name":"Delete Asset","id":"98ebaf75-ef79-4593-b3b1-7f6ee1199e60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/v4/asset/:type/:name/","description":"

Delete a Ytel hosted asset.

We accept types audio, mms-image, meme-image, inboundxml

\n","type":"text/plain"},"type":"any","value":"audio","key":"type"},{"id":"eac29f71-f732-43d7-bf28-9f5bb04ce399","description":{"content":"

The name of the file in the UI used for identification.

\n","type":"text/plain"},"type":"any","value":"testwav.wav","key":"name"}]}},"response":[{"id":"557cd7d0-b90c-4d91-b9d0-85a47ee91b14","name":"Sample Request","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{url}}/v4/asset/:type/:name/","host":["{{url}}"],"path":["v4","asset",":type",":name",""],"variable":[{"key":"type","value":"audio","description":"We accept types `audio`, `mms-image`, `meme-image`, `inboundxml`"},{"key":"name","value":"testwav.wav","description":"The name of the file in the UI used for identification."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"366","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"type\": \"audio\",\n \"name\": \"testwav.wav\",\n \"description\": null,\n \"creationDate\": 1617680772856,\n \"modificationDate\": 1617680772856,\n \"status\": 1,\n \"publicUrl\": \"https://client-assets.ytel.com/83dcb6d6-5513-4962-4911-541d33774000.wav\",\n \"duration\": 16,\n \"mimeType\": \"audio/wav\",\n \"size\": 6459630\n }\n ]\n}"}],"_postman_id":"98ebaf75-ef79-4593-b3b1-7f6ee1199e60"},{"name":"Upload Asset","id":"11c83d87-937a-4a62-9dc6-9ce8982b5bba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"multipart/form-data","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"","description":"

Your Audio, Image or InboundXML file. (.wav, .mp3, .png,.gif, .jpg, .xml)

\n","type":"file","src":"/Users/testwav.wav"},{"key":"type","value":"audio","description":"

We accept types audio, mms-image, meme-image, inboundxml

\n","type":"text"},{"key":"name","value":"myaudio.wav","description":"

The name of the resulting file in the UI for identification.

\n","type":"text"}]},"url":"{{url}}/v4/asset/","description":"

The publicUrl returned may be used in future API requests.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","asset",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6ad5915e-bff5-4c6c-9ffa-075343752d87","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"multipart/form-data","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"","description":"Your Audio, Image or InboundXML file. (.wav, .mp3, .png,.gif, .jpg, .xml)","type":"file","src":["/Users/testwav.wav"]},{"key":"type","value":"audio","description":"We accept types `audio`, `mms-image`, `meme-image`, `inboundxml`","type":"text"},{"key":"name","value":"myaudio.wav","description":"The name of the resulting file in the UI for identification.","type":"text"}]},"url":"{{url}}/v4/asset/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"367","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"type\": \"audio\",\n \"name\": \"myaudio.wav\",\n \"description\": null,\n \"creationDate\": 1617669481388,\n \"modificationDate\": 1617669481388,\n \"status\": 1,\n \"publicUrl\": \"https://client-assets.ytel.com/644cf6df-7652-4618-8412-849994bb9a00.wav\",\n \"duration\": 16,\n \"mimeType\": \"audio/wave\",\n \"size\": 6459630\n }\n ]\n}"}],"_postman_id":"11c83d87-937a-4a62-9dc6-9ce8982b5bba"},{"name":"Update Asset","id":"602c0fa0-e5fd-45de-a3f7-77c5a1e78453","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"multipart/form-data"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n"}],"body":{"mode":"formdata","formdata":[{"key":"","description":"

Your Audio, Image or InboundXML file. (.wav, .mp3, .png,.gif, .jpg, .xml)

\n","type":"file","src":"/Users/testwav.wav"},{"key":"type","value":"audio","description":"

We accept types audio, mms-image, meme-image, inboundxml

\n","type":"text"},{"key":"name","value":"myaudio.wav","description":"

The name of the resulting file in the UI for identification.

\n","type":"text"}]},"url":"{{url}}/v4/asset/","description":"

The publicUrl returned may be used in future API requests.

Assets are Audio, Image, and InboundXML files that are hosted within the Ytel ecosystem.

This allows for us to host and utilize your files from a resource local to us. This results in a performance gain for your application.

By default a user may only see and modify assets that are owned by the user or have been shared with them either directly or by inclusion within a work group. Users with the asset-read permission have the ability to see all assets in the system. Users with the asset-update permission have the ability to modify any assets in the system.

\n","_postman_id":"09d9655d-2a18-4695-b297-feb9011737f9","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Billing","item":[{"name":"Get Usage","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"5716dc0c-ff2f-41d0-8f68-3a6abd5f290a"}}],"id":"7f6cc58c-a814-459f-9fc0-99ec7d6bffa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{url}}/v4/billing/report/?startDate=2021-01-10&endDate=2021-01-11&accountSid=","description":"

Gets a usage report for an account between two days (inclusive) in UTC. There is a limit to pulling 90 days of usage at a time.

rowCount: Number of instances this item was billed in the given time range.
billedCount: Number of items billed. This may be different than the row count for entries where multiple items are billed at the same time. For example a large sms message may be billed for 2 or 3 messages on a single send.
totalDuration: Number of seconds for this item. Not always present for things without a duration.
cost: Base charge for these items.
finalCost: Total cost for these items. For rows with surcharges, this will include those values.
serviceType: The general category for this item. Examples: call, sms
subType: Subtype of this item.
lob: Line of business. Example: api, broadcast
description: Human readable description for what the charge is for
itemCode: Billable item code.

Start date in the format YYYY-MM-DD

\n","type":"text/plain"},"key":"startDate","value":"2021-01-10"},{"description":{"content":"

End date in the format YYYY-MM-DD

\n","type":"text/plain"},"key":"endDate","value":"2021-01-11"},{"description":{"content":"

The Account you would like to look up. This parameter is optional.

\n","type":"text/plain"},"key":"accountSid","value":""}],"variable":[]}},"response":[{"id":"061da12d-d4d8-4d5f-9153-4c250642b019","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text","disabled":true},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/billing/report/?startDate=2021-01-10&endDate=2021-01-11&accountSid=","host":["{{url}}"],"path":["v4","billing","report",""],"query":[{"key":"startDate","value":"2021-01-10","description":"Start date in the format YYYY-MM-DD"},{"key":"endDate","value":"2021-01-11","description":"End date in the format YYYY-MM-DD"},{"key":"accountSid","value":"","description":"The Account you would like to look up. This parameter is optional."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2703","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 15,\n \"page\": 1,\n \"payload\": [\n {\n \"billedCount\": 4,\n \"rowCount\": 4,\n \"totalDuration\": 54,\n \"finalCost\": 0,\n \"cost\": 0,\n \"serviceType\": \"call\",\n \"subType\": \"cti\",\n \"lob\": \"api\",\n \"description\": \"API toll free inbound call - US\",\n \"itemCode\": \"ActiUS\"\n },\n {\n \"billedCount\": 8,\n \"rowCount\": 4,\n \"totalDuration\": 0,\n \"finalCost\": 0,\n \"cost\": 0,\n \"serviceType\": \"mrc_did\",\n \"subType\": \"nu\",\n \"lob\": \"api\",\n \"description\": \"API local number - US\",\n \"itemCode\": \"AnuUS\"\n },\n {\n \"billedCount\": 1187,\n \"rowCount\": 58,\n \"totalDuration\": 62184,\n \"finalCost\": 0,\n \"cost\": 0,\n \"serviceType\": \"call\",\n \"subType\": \"ci\",\n \"lob\": \"api\",\n \"description\": \"API local inbound call - US\",\n \"itemCode\": \"AciUS\"\n },\n {\n \"billedCount\": 2,\n \"rowCount\": 2,\n \"totalDuration\": 0,\n \"finalCost\": 0,\n \"cost\": 0,\n \"serviceType\": \"mrc_did\",\n \"subType\": \"nu\",\n \"lob\": \"broadcast\",\n \"description\": \"Broadcast number \",\n \"itemCode\": \"Bnu\"\n },\n {\n \"billedCount\": 1149,\n \"rowCount\": 48,\n \"totalDuration\": 61842,\n \"finalCost\": 0,\n \"cost\": 0,\n \"serviceType\": \"call\",\n \"subType\": \"co\",\n \"lob\": \"api\",\n \"description\": \"API local outbound call - US\",\n \"itemCode\": \"AcoUS\"\n },\n {\n \"billedCount\": 2,\n \"rowCount\": 1,\n \"totalDuration\": 30,\n \"finalCost\": 0.5,\n \"cost\": 0.5,\n \"serviceType\": \"call\",\n \"subType\": \"co\",\n \"lob\": \"api\",\n \"description\": \"API local outbound call - PR\",\n \"itemCode\": \"AcoPR\"\n },\n {\n \"billedCount\": 4,\n \"rowCount\": 4,\n \"totalDuration\": 0,\n \"finalCost\": 0,\n \"cost\": 0,\n \"serviceType\": \"sms\",\n \"subType\": \"sco\",\n \"lob\": \"api\",\n \"description\": \"API short code outbound SMS - US\",\n \"itemCode\": \"AscoUS\"\n },\n {\n \"billedCount\": 1173,\n \"rowCount\": 114,\n \"totalDuration\": 0,\n \"finalCost\": 0,\n \"cost\": 0,\n \"serviceType\": \"sms\",\n \"subType\": \"so\",\n \"lob\": \"api\",\n \"description\": \"API local outbound SMS - US\",\n \"itemCode\": \"AsoUS\"\n },\n {\n \"billedCount\": 1,\n \"rowCount\": 1,\n \"totalDuration\": 0,\n \"finalCost\": 0,\n \"cost\": 0,\n \"serviceType\": \"sms\",\n \"subType\": \"sci\",\n \"lob\": \"api\",\n \"description\": \"API short code inbound SMS - US\",\n \"itemCode\": \"AsciUS\"\n },\n {\n \"billedCount\": 4,\n \"rowCount\": 1,\n \"totalDuration\": 0,\n \"finalCost\": 0,\n \"cost\": 0,\n \"serviceType\": \"sms\",\n \"subType\": \"sblock\",\n \"lob\": \"api\",\n \"description\": \"International block - US\",\n \"itemCode\": \"AsblockUS\"\n },\n {\n \"billedCount\": 12,\n \"rowCount\": 9,\n \"totalDuration\": 0,\n \"finalCost\": 0,\n \"cost\": 0,\n \"serviceType\": \"sip\",\n \"subType\": \"sipo\",\n \"lob\": \"api\",\n \"description\": \"API SIP outbound call - US\",\n \"itemCode\": \"AsipoUS\"\n },\n {\n \"billedCount\": 575,\n \"rowCount\": 49,\n \"totalDuration\": 0,\n \"finalCost\": 0,\n \"cost\": 0,\n \"serviceType\": \"sms\",\n \"subType\": \"si\",\n \"lob\": \"api\",\n \"description\": \"API local inbound SMS - US\",\n \"itemCode\": \"AsiUS\"\n },\n {\n \"billedCount\": 2900,\n \"rowCount\": 94,\n \"totalDuration\": 0,\n \"finalCost\": 0,\n \"cost\": 0,\n \"serviceType\": \"carrierlu\",\n \"subType\": \"carrierlu\",\n \"lob\": \"api\",\n \"description\": \"API carrier lookup - US\",\n \"itemCode\": \"AcaUS\"\n },\n {\n \"finalCost\": 0.00702,\n \"cost\": 0.00702,\n \"description\": \"Tax total\",\n \"itemCode\": \"Tax\"\n },\n {\n \"finalCost\": 0.0487,\n \"cost\": 0.0487,\n \"description\": \"Surcharge total\",\n \"itemCode\": \"Surcharge\"\n }\n ]\n}"}],"_postman_id":"7f6cc58c-a814-459f-9fc0-99ec7d6bffa2"}],"id":"8e00ac3d-cdf8-49f1-b9bb-a2df43e662a6","description":"

Used to obtain your billing usage summary data. These endpoints are intended to be used within the UI.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b345ca07-029d-4bba-a8ac-3d4f4f47400a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a12fc1ed-b113-4fb1-aa36-77dff534e9e1"}}],"_postman_id":"8e00ac3d-cdf8-49f1-b9bb-a2df43e662a6","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Call","item":[{"name":"Make Call","id":"5c454c03-4e28-40ba-9b45-f156963ead1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"from\": \"{{fromnumber}}\",\n \"to\": \"{{tonumber}}\",\n \"url\": \"{{xmlurl}}\",\n \"statusCallbackUrl\": \"{{callbackurl}}\",\n \"metadata\": {\n \"referenceId\": \"myrefId\",\n \"leadId\": \"leadId\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/call/","description":"

Initiates a phone call. This endpoint supports multiple different ways to start a call with many fields that are mutually exclusive.

For the destination phone number either the to field or the contactId field must be provided. If a contactId is provided, the destination number will be looked up from their contact information.

For the source phone number either the from field or the numberSetId field must be provided. If the numberSetId field is used, a number will be chosen from the number set at random.

The url parameter is required and points to an InboundXML file that describes how the call should be handled. The default method for sending data is POST. If you would like to specify the method you can pass GET or POST in the urlMethod JSON object.

The statusCallbackUrl and fallbackUrl are REST endpoints that will be contacted at the completion of the phone call. In the event that there is an error with the statusCallbackUrl, the fallbackUrl will be used.

The heartbeatCallbackUrl will be hit every 60 seconds while the call is active.

The record and recordCallbackUrl parameters dictate whether the call will be recorded. If set to true (default false) after the recording is complete a callback will be made to the url specified in recordCallbackUrl.

The ifMachine and ifMachineCallbackUrl parameters dictate what will happen if an answering machine or voice mail is detected. ifMachine may be one of hangup or continue. ifMachineCallabckUrl will be called with a callback if specified.

The timeout parameter specifies the number of seconds that will be waited for a call to be connected.

The playDtmf parameter specifies a set of dialtones to play after a call is completed. The valid values are 0-9,#,*.

The hideCallerId parameter specifies whether the callerId will be hidden. Default false.

The checkFederalDnc parameter specifies whether the federal dnc should be checked. Default false. This will result in an error if the account does not have access to the federal dnc.

The metadata parameter will allow for passing key/value pairs. If provided, these values will be available on the call log record as well as any callbacks that are configured for calls.

We recommend using number sets and contacts since these will result in fewer changes over time.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"from\": \"+1951356123\",\n \"to\": [\"+17142221234\", \"+17142220000\"],\n \"url\": \"https://customapps.ytel.com/m360/examples/welcome/index.php\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/groupcall/","description":"

Initiates multiple phone calls. This endpoint supports multiple different ways to start a call with many fields that are mutually exclusive. Note this is not a conference call and the contacted users will all receive the same call handling.

For the destination phone number either the to field or the contactIds field must be provided. If a contactIds is provided, the destination number will be looked up from their contact information.

For the source phone number either the from field or the numberSetId field must be provided. If the numberSetId field is used, a number will be chosen from the number set at random.

The url parameter is required and points to an InboundXML file that describes how the call should be handled. For more information see: https://docs.ytel.com/docs/getting-started-now

The statusCallbackUrl and fallbackUrl are REST endpoints that will be contacted at the completion of the phone call. In the event that there is an error with the statusCallbackUrl, the fallbackUrl will be used.

The heartbeatCallbackUrl will be hit every 60 seconds while the call is active.

The record and recordCallbackUrl parameters dictate whether the call will be recorded. If set to true (default false) after the recording is complete a callback will be made to the url specified in recordCallbackUrl.

The transcribe and transcibeCallbackUrl parameters dictate whether the call will be transcribed. If set to true (default false) after the transcription is complete a callback will be made to the url specified in transcribeCallbackUrl.

The ifMachine and ifMachineCallbackUrl parameters dictate what will happen if an answering machine or voice mail is detected. ifMachine may be one of hangup or continue. ifMachineCallabckUrl will be called with a callback if specified.

The timeout parameter specifies the number of seconds that will be waited for a call to be connected.

The playDtmf parameter specifies a set of dialtones to play after a call is completed. The valid values are 0-9,#,\\*.

The hideCallerId parameter specifies whether the callerId will be hidden. Default false.

The groupConfirmKey parameter indicates the number that should be pressed by a participant to cancel all other calls. The groupConfirmFile plays the DTMF prompt to the answering party.

The metadata parameter will allow for passing key/value pairs. If provided, these values will be available on the call log record as well as any callbacks that are configured for calls.

We recommend using number sets and contacts since these will result in fewer changes over time.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"playDtmf\": \"0123456789*#\"\r\n}"},"url":"{{url}}/v4/call/sendDigit/:callSid","description":"

Sends phone number digit sounds to the specified call.

The playDtmf parameter is the series of dtmf tones that will be played into the call. Valid values are 0-9,*,#.

Call id that will be adjusted

\n","type":"text/plain"},"type":"any","value":"deafbeef-1111-1111-abba-cab0fade4de8","key":"callSid"}]}},"response":[],"_postman_id":"bac85b60-f58d-4030-a09e-3290061a7182"},{"name":"Record Call","id":"f9fb55e1-d0a3-45d8-9e00-432d6819ec0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"timeLimit\": \"100\",\n \"callbackUrl\": \"https://aab6d95b5690dd0c56572306c11a4ceb.m.pipedream.net\",\n \"direction\": \"both\",\n \"fileFormat\": \"mp3\",\n \"stopRecordingOnKey\": \"0\"\n\n}"},"url":"{{url}}/v4/call/record/:callSid ","description":"

Begins recording of a call.

The timeLimit parameter is the maximum number of seconds to record. This must be set and set to a positive value.

The callbackUrl parameter is the endpoint that will be hit after the call recording is completed.

The direction parameter specifies which direction of the call will be recorded. Valid values are in, out, and both.

The fileFormat parameter specifies the file format that the recording will be saved in. Valid values are mp3 and wav.

The stopRecordingOnKey parameter is the dtmf tone that will stop recording. Optional.

Generated using the v4 Authentication endpoint.

Plays audio for an ongoing call.

The audioUrl parameter is a url for an audio file that will be played into the existing call. This is mutually exclusive with sayText.

The sayText parameter is text that will be converted to audio and played into the call. This is mutually exclusive with audioUrl.

The length parameter is the length of the audio file. Default 0.

The mix parameter indicates whether the audio should be mixed into the existing all. Default false.

{\n  \"sayText\": \"Hello from Ytel\"\n}\n

and

{\n  \"audioUrl\": \"https://customapps.ytel.com/operations/matt/cluck.mp3\"\n}\n

","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","call","play",":callSid"],"host":["{{url}}"],"query":[],"variable":[{"id":"febc5979-334f-4318-a568-eb0bbd7c80dc","type":"any","value":"950ca760-5b5e-11eb-8226-13e20bbc9f4f","key":"callSid"}]}},"response":[{"id":"42333315-530a-4a08-8597-d80d15f79209","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"sayText\": \"Hello from Ytel\"\n}"},"url":{"raw":"{{url}}/v4/call/play/:callSid","host":["{{url}}"],"path":["v4","call","play",":callSid"],"variable":[{"key":"callSid","value":"f590eb70-6570-11eb-b88e-cfc638968ed7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"66","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"sentToCall\": true\n }\n ]\n}"}],"_postman_id":"942e4c7f-ec0d-468c-a40d-53b9a6b76bd8"},{"name":"Interupt Call","id":"1f1667c3-6b62-404e-9b4a-4e3a4a8e50c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"completed\",\n \"url\": \"https://customapps.ytel.com/m360/examples/welcome/index.php\",\n \"urlMethod\": \"POST\"\n}"},"url":"{{url}}/v4/call/interrupt/:callSid","description":"

Interrupts an ongoing call.

The status parameter indicates how the call should be interrupted. Valid values are completed and canceled. These values indicate how the call will be recorded in the logs.

The url parameter is used in conjuction with the status set to completed to continue the call with a new InboundXML file. If this field is not present, the call will be killed.

You may also specify the method of the post to the url resource by adding the urlMethod object and passing GET or POST (POST is the default) as the value.

This request gets a list of active calls for the account associated with the Bearer Token. After a call is terminated, it should not show in this list.

callSid is a unique identifier for each call or leg of the call.

createdAt is when the call started.

In rare cases where termination is not recorded properly, the expiresAt value is used internally to filter them out.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","call","live"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"c1943f90-896d-4f63-8439-ed082bd02720","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}"},{"key":"Accept","value":"application/json"}],"url":"{{url}}/v4/call/live"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 2,\n \"page\": 1,\n \"payload\": [\n {\n \"callSid\": \"3a0197cd-8799-4aaa-b06a-3d73466739a2\",\n \"to\": \"+12223334444\",\n \"from\": \"+13334445555\",\n \"direction\": \"outbound\",\n \"clientId\": null,\n \"timeStarted\": 1705434723800,\n \"expiresAt\": 1705456323800\n },\n {\n \"callSid\": \"b8967e80-b4a8-11ee-85e6-9d409c3ff1e6\",\n \"to\": \"+12223334444\",\n \"from\": \"+13334445555\",\n \"direction\": \"outbound\",\n \"clientId\": null,\n \"timeStarted\": 1705434725480,\n \"expiresAt\": 1705456325480\n }\n ]\n}"}],"_postman_id":"e4c534f7-eabd-41d0-b55e-06bca320b451"}],"id":"895202ff-b15b-400c-9a4a-6d6236be38b4","_postman_id":"895202ff-b15b-400c-9a4a-6d6236be38b4","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Carrier","item":[{"name":"Get Carrier","event":[{"listen":"test","script":{"id":"47f1ef36-bf21-48bb-a0d7-6114b98b1274","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","pm.test(\"Check Company\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.payload[0].company).to.eql(\"T-Mobile USA Inc\");","});","pm.test(\"Check API Version\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.payload[0].apiVersion).to.eql(\"4\");","});","pm.test(\"Check Network\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.payload[0].network).to.eql(\"T-Mobile\");","});","pm.test(\"Check Wireless\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.payload[0].wireless).to.eql(true);","});","pm.test(\"Check City\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.payload[0].city).to.eql(\"Irvine\");","});","pm.test(\"Check Status\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.payload[0].status).to.eql(true);","});",""],"type":"text/javascript"}}],"id":"1fb0b7af-ce76-4175-8696-0ad519633b92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/carrier/lookup/:phoneNumber/","description":"

Lookup carrier information for a phone number.

Returned fields:

apiVersion: always 4
carrierSid: transaction id for the carrier lookup
phoneNumber: phone number that was passed in for the lookup request
network: Name of the network. There is little consistency for these names. If looking for a particular carrier you'll want to do a case-insensitive search for the major carrier name (ex: verizon, sprint, att, etc.) and remove all non-alpha characters.
wireless: Boolean value indicating if it is a wireless number.
zipCode: zip code where the phone is registered
city: city where the phone is registered
state: state where the phone is registered
status: currently always true
dateCreated: last time data was updated

Of note, the city, state, and zip codes are not necessarily where the owner of the phone resides.

E.164 Formatted phone number

\n","type":"text/plain"},"type":"any","value":"{{tonumber}}","key":"phoneNumber"}]}},"response":[{"id":"04d4319d-9570-4ee0-b203-a09b996e8b61","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/carrier/lookup/:phoneNumber/","host":["{{url}}"],"path":["v4","carrier","lookup",":phoneNumber",""],"variable":[{"key":"phoneNumber","value":"+15714345400","description":"E.164 Formatted phone number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"361","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"148","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"apiVersion\": \"4\",\n \"carrierSid\": \"58f04910-5502-11eb-8226-13e20bbc9f4f\",\n \"phoneNumber\": \"+15714345400\",\n \"network\": \"Level 3\",\n \"company\": \"Level 3 Communications LLC\",\n \"wireless\": false,\n \"zipCode\": \"20601\",\n \"city\": \"Waldorf\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"status\": true,\n \"dateCreated\": \"2020-11-05T13:47:31.996Z\",\n \"date\": 1610475413537\n }\n ]\n}"}],"_postman_id":"1fb0b7af-ce76-4175-8696-0ad519633b92"}],"id":"8dc0e9ed-8333-4fc3-b310-99cf6177b6ae","description":"

Phone number carrier related endpoints.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"723ff679-e275-4645-bacf-2cbfa0fba1e1"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f26b5be5-57c6-4253-af80-b89d5246309c"}}],"_postman_id":"8dc0e9ed-8333-4fc3-b310-99cf6177b6ae","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Conference","item":[{"name":"List conference members","id":"bf01b1b7-938e-46a2-83b3-b3f824304728","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n"}],"url":"{{url}}/v4/conference/{{confId}}/member/","description":"

Get a list of member ID's and their data by conference ID

Return payload:

{\n  \"confId\": UUID,\n  \"members\": [\n    \"memberId\": Integer, // member ID of this member used for other APIs\n    \"name\": String,  // name of this channel. usually the phone number associated with the external entity\n    \"callSid\": UUID, // callSid of the member\n    \"callerIdName\": String, //Caller ID name string used if outbound\n    \"callerIdNumber\": String, //caller ID number string used if outbound\n    \"mute\": boolean,  // currently muted or not\n    \"deaf\": boolean,  // currently deaf or not. meaning can't hear anyone\n    \"ghost\": boolean  // is a ghost member.  meaning this member doesn't count as a full member.  Usualy something like a Recording line.\n  ]\n}\n\n

Generated using the v4 Authentication endpoint.

\n"}],"url":"{{url}}/v4/conference/{{confId}}/member/{{memberId}}/kick","description":"

Kick a member from a conferece. you provide the conference ID and the Member ID you wich to kick form the conference. Currently this has the same effect as hangup conference member.

Return payload

{\n  \"sentToCall\": boolean // if it was able to be sent\n}\n\n

Generated using the v4 Authentication endpoint.

\n"}],"url":"{{url}}/v4/conference/{{confId}}/member/{{memberId}}/hangup","description":"

Hangup the call leg that the conference memeber joined on. Again this requires the conference ID and the member ID. In this case it speicifically hangs up the call.

Return payload

{\n  \"sentToCall\": boolean // if it was able to be sent\n}\n\n

Generated using the v4 Authentication endpoint.

\n"}],"url":"{{url}}/v4/conference/{{confId}}/member/{{memberId}}/mute","description":"

Mute a conference member by conference ID and member ID

Return payload

{\n  \"sentToCall\": boolean // if it was able to be sent\n}\n

Generated using the v4 Authentication endpoint.

\n"}],"url":"{{url}}/v4/conference/{{confId}}/member/{{memberId}}/mute","description":"

If a member has been muted by the API, unmute them by conference ID and member ID

Return payload:

{\n  \"sentToCall\": boolean // if it was able to be sent\n}\n

Generated using the v4 Authentication endpoint.

\n"}],"url":"{{url}}/v4/conference/{{confId}}/member/{{memberId}}/deaf","description":"

Deaf a conference member by conference ID and member ID. This makes it so they will hear nothing from the conference. This does not mute them, they will still be able to speak unless muted.

Return payload:

{\n  \"sentToCall\": boolean // if it was able to be sent\n}\n\n

Generated using the v4 Authentication endpoint.

\n"}],"url":"{{url}}/v4/conference/{{confId}}/member/{{memberId}}/deaf","description":"

Un-deaf a conference member by conference ID and member ID. If they were set to deaf, now they will be able to hear the conference again.

Return payload:

{\n  \"sentToCall\": boolean // if it was able to be sent\n}\n\n

Generated using the v4 Authentication endpoint.

\n"}],"body":{"mode":"raw","raw":"{\n \"confId\": \"{{confId}}\",\n \"audioUrl\": \"{{audioUrl}}\",\n \"hangupCallSid\": \"{{hangupCallSid}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/conference/{{confId}}/exitAudio","description":"

This will play audio into the conference while allowing you to speicify a callSid to hangup on. General use case is you want to play an audio file and leave the conference yourself, so you would specify your call SID here. Reaons for this is if there are less that 2 members in the conference everyone will be forced to leave. While the audio is playing it will maintain that requirement.

Return payload:

{\n  \"sentToCall\": boolean // if it was able to be sent\n}\n

Generated using the v4 Authentication endpoint.

\n"}],"body":{"mode":"raw","raw":"{\n\t\"from\": \"{{account_phonenumber}}\", //required\n\t\"to\":\"{{destination_phonenumber}}\", // required\n \"confId\":\"{{confId}}\", // required\n \"mute\": boolean, // optional to join muted\n \"deaf\": boolean, // optional to join Deaf\n \"noSpeakToList\": [\"\"] // optional list of callSid or memberID's that this member will not be able to talk to on the conference.\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/conference/{{confId}}/participant","description":"

Add a pariticipant to an active conference.

Request

{\n    \"from\": \"{{account_phonenumber}}\",  //required\n    \"to\":\"{{destination_phonenumber}}\", // required\n    \"confId\":\"{{confId}}\", // required\n    \"mute\": boolean, // optional to join muted\n    \"deaf\": boolean, // optional to join Deaf\n    \"noSpeakList\": [\"\"] // optional list of callSid or memberID's that this member will not be able to talk to on the conference.\n}\n\n

Return payload:

{\n  \"callSid\": UUID, // New call ID that was created\n  \"createdTime\": String // timestamp of the created call time.\n}\n\n

Generated using the v4 Authentication endpoint.

\n"}],"body":{"mode":"raw","raw":"{\n\t\"from\": \"{{account_phonenumber}}\",\n\t\"to\":\"{{destination_number}}\",\n \"confId\":\"{{confId}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/conference/{{confId}}/listen","description":"

Add a member to a conference, but in listen only mode.

Return payload:

{\n  \"callSid\": UUID, // New call ID that was created\n  \"createdTime\": String // timestamp of the created call time.\n}\n

Generated using the v4 Authentication endpoint.

\n"}],"body":{"mode":"raw","raw":"[\n {\n \"source\": {{memberId}},\n \"destination\": {{memberId}},\n \"linkType\": \"nospeak|clear\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/conference/{{confId}}/audioMap","description":"

This endpoint allows you advanced control of member to member audio mapping. Who can hear who. Using \"nospeak\" would mean audio in the direction form source to destination will not flow. Using \"clear\" will remove this rule.

Return payload:

{\n  \"sentToCall\": boolean // if it was able to be sent\n}\n

Generated using the v4 Authentication endpoint.

\n"}],"url":"{{url}}/v4/conference/{{confId}}/member/{{memberId}}/clearAllMute","description":"

Removes all audio mappings and muting for the member ID passed.

Return payload:

{\n  \"sentToCall\": boolean // if it was able to be sent\n}\n

Conferences come have two types.

First is referred to as miniconf, the other is a standard conference.

A miniconf is designed to allow a small number of members to be on the phone, but with the requirement that there be at least two people on the line. Once the level of people have gone above 1 if it falls below two the converence will end.

Standard conferences will be covered at a later time.

Mini conferences are automatically used for Proxy type calls and WebRTC calls inbound and outbound. API initiated, standard inbound, or XML based dial command the miniconf option is available to request it be created for the call. This is gernally used only when bridging two calls together. Reasons for this are to offer more functionality. Like playing audio to all members or listening into a call etc.

\n","_postman_id":"85853639-1074-42c0-9e28-663409b1d1e9","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Contacts","item":[{"name":"Get Contacts","id":"72439b8e-2aa0-4005-82ab-814aafb2e740","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/contact/","description":"

Retrieves up to 1000 contacts on the account.

This endpoint is the equivalent of sending a search request with no parameters.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"extData\": {\r\n \t\"firstname\":\"John\",\r\n \t\"lastname\":\"Tester\",\r\n \t\"phonenumber1\":\"+17142220000\",\r\n \t\"email1\":\"johntester@testemail.com\",\r\n \t\"address1\":\"1101 Northshore Dr.\",\r\n \t\"city1\":\"Columbia\",\r\n \t\"zip1\":\"65203\",\r\n \t\"country1\":\"US\",\r\n \t\"notes\":\"This is another contact.\"\r\n },\r\n \"keys\":[\r\n \t\"+17142220000\",\r\n \t\"johntester.alt@testemail.com\"\r\n ]\r\n}\r\n"},"url":"{{url}}/v4/contact/","description":"

Adds a new contact.

In the event of a key conflict, this will return an error with the existing contactId.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","contact",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"25eb0143-e4f5-4973-b5ef-8d57344669e7","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Content-type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"extData\": {\r\n \t\"firstname\":\"John\",\r\n \t\"lastname\":\"Tester\",\r\n \t\"phonenumber1\":\"+17142220000\",\r\n \t\"email1\":\"johntester@testemail.com\",\r\n \t\"address1\":\"1101 Northshore Dr.\",\r\n \t\"city1\":\"Columbia\",\r\n \t\"zip1\":\"65203\",\r\n \t\"country1\":\"US\",\r\n \t\"notes\":\"This is another contact.\"\r\n },\r\n \"keys\":[\r\n \t\"+17142220000\",\r\n \t\"johntester.alt@testemail.com\"\r\n ]\r\n}\r\n"},"url":"{{url}}/v4/contact/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"513","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"contactId\": \"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf\",\n \"created\": \"86b0cea0-5a80-11eb-a4f7-51ea502320d5\",\n \"dnc\": 0,\n \"timezone\": -24,\n \"extData\": {\n \"firstname\": \"John\",\n \"email1\": \"johntester@testemail.com\",\n \"city1\": \"Columbia\",\n \"phonenumber1\": \"+17142220000\",\n \"notes\": \"This is another contact.\",\n \"address1\": \"1101 Northshore Dr.\",\n \"country1\": \"US\",\n \"zip1\": \"65203\",\n \"lastname\": \"Tester\"\n },\n \"keys\": [\n \"+17142220000\",\n \"johntester.alt@testemail.com\"\n ]\n }\n ]\n}"}],"_postman_id":"8ba8b9b1-0cc8-4ed7-acca-4cbc38f59969"},{"name":"Search Contacts","id":"59b7e6fa-0ce8-49e6-a01d-7d561841c512","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"size\": 5000,\n \"keys\": [\n \"+17142220000\"\n ],\n \"statements\": [\n {\n \"operation\": \"contains\",\n \"value\": \"John\",\n \"variable\": \"firstname\"\n }\n ]\n}"},"url":"{{url}}/v4/contact/search","description":"

Allows searching for contacts. There are two different modes, key search and statement search. If both are provided it will only do a key search.

When doing a key search all the records that have one of the provided keys will be returned.

When doing a statement search all records that match all of the criteria will be returned. Each statement must contain three values variable, operation, and value. The variable will be one of the extData keys. operation must be either equal, equals, or contains. value is the value that will be matched against. In the example below it will find all contacts what have a first name that contains \"Roy\".

The size parameter is only valid for statement searches. It is currently capped at 10,000 results.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","contact","search"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"33e293cf-14ed-4cbe-bf27-663738d93b0a","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"size\": 5000,\n \"keys\": [\n \"+17142220000\"\n ],\n \"statements\": [\n {\n \"operation\": \"contains\",\n \"value\": \"John\",\n \"variable\": \"firstname\"\n }\n ]\n}"},"url":"{{url}}/v4/contact/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"513","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"contactId\": \"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf\",\n \"created\": \"86b0cea0-5a80-11eb-a4f7-51ea502320d5\",\n \"dnc\": 0,\n \"timezone\": -24,\n \"extData\": {\n \"firstname\": \"John\",\n \"email1\": \"johntester@testemail.com\",\n \"city1\": \"Columbia\",\n \"phonenumber1\": \"+17142220000\",\n \"notes\": \"This is another contact.\",\n \"address1\": \"1101 Northshore Dr.\",\n \"country1\": \"US\",\n \"zip1\": \"65203\",\n \"lastname\": \"Tester\"\n },\n \"keys\": [\n \"+17142220000\",\n \"johntester.alt@testemail.com\"\n ]\n }\n ]\n}"}],"_postman_id":"59b7e6fa-0ce8-49e6-a01d-7d561841c512"},{"name":"Upload Contacts","id":"98351518-6dfa-4c53-a0a8-e5c4ebc65e25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"parts","description":"

The file containing your contact records

\n","type":"file","src":"/Users/matt/Desktop/contacts.txt"}]},"url":"{{url}}/v4/contact/upload?conflictMode=REJECT","description":"

Uploads a csv file that will be populated as contacts in the system.

The first line will be the header, which will map to extData fields on the contact

phonenumber1,firstname,lastname,candy\n+17148675309,Jenny,Doe,red hots\n+17148675310,John,Doe,snickers\n

There is an optional conflictMode variable that can be passed when uploading a list. This value can be REJECT (default), APPEND, OVERWRITE, or REPLACE. \nModes:

REJECT The new data is rejected. The existing data is preserved. This will generate an error.
REPLACE The new data is inserted. Existing data is removed.
APPEND New data is inserted. Existing data is preserved. Key conflicts keep the old data.
OVERWRITE New data is inserted. Existing data is preserved unless there is a key conflict where it is replaced.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"parts","description":"

The file containing your contact records

\n","type":"file","src":"/Users/matt/Desktop/contacts.txt"}]},"url":"{{url}}/v4/contact/uploadAsync?conflictMode=REJECT&callback=websocket&incrementalCallback=true","description":"

Uploads a csv file that will be populated as contacts in the system asynchronously.

The first line will be the header, which will map to extData fields on the contact

phonenumber1,firstname,lastname,candy\n+17148675309,Jenny,Doe,red hots\n+17148675310,John,Doe,snickers\n

There is an optional conflictMode variable that can be passed when uploading a list. This value can be REJECT (default), APPEND, OVERWRITE, or REPLACE. \nModes:

REJECT The new data is rejected. The existing data is preserved. This will generate an error.
REPLACE The new data is inserted. Existing data is removed.
APPEND New data is inserted. Existing data is preserved. Key conflicts keep the old data.
OVERWRITE New data is inserted. Existing data is preserved unless there is a key conflict where it is replaced.

If the optional callback parameter is passed then a callback will be made upon the completion of the file upload. Valid values are websocket, the id of a webhook, or a URL. Additionally if the incrementalCallback (default false) parameter is set to true then status updates will be sent to the configured callback. If using a webhook, the id must correspond to a webhook of type api_callback.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"extData\": {\r\n \"variablename\": \"update contact data\",\r\n \"firstname\": \"John\",\r\n \"lastname\": \"Tester\",\r\n \"externalcontactkey\": \"myuniqueid\",\r\n \"phonenumber1\": \"+16192331234\"\r\n },\r\n \"keys\": [\r\n \t\"+16192331234\",\r\n \"myuniqueid\"\r\n ],\r\n \"rmkeys\": [\r\n \"myolduniqueid\"\r\n ]\r\n}"},"url":"{{url}}/v4/contact/:contactId","description":"

Edits a contact.

Similar to uploading a list, this has an optional conflictMode parameter (default REPLACE). Using REJECT will result in an error. Using APPEND will result in the existing contact data remaining with new key/value pairs being added. OVERWRITE will replace existing key/value pairs but not remove existing ones.

In any case, only non-null fields that are passed in will be updated.

The contactId of the record to edit

\n","type":"text/plain"},"type":"any","value":"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf","key":"contactId"}]}},"response":[{"id":"e7ac7195-6edd-4895-a4d3-c41760c8965e","name":"Sample Request","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"extData\": {\r\n \"variablename\": \"update contact data\",\r\n \"firstname\": \"John\",\r\n \"lastname\": \"Tester\",\r\n \"externalcontactkey\": \"myuniqueid\",\r\n \"phonenumber1\": \"+16192331234\"\r\n },\r\n \"keys\": [\r\n \t\"+16192331234\",\r\n \"myuniqueid\"\r\n ],\r\n \"rmkeys\": [\r\n \"myolduniqueid\"\r\n ]\r\n}"},"url":{"raw":"{{url}}/v4/contact/:contactId","host":["{{url}}"],"path":["v4","contact",":contactId"],"variable":[{"key":"contactId","value":"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf","description":"contactId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"469","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"148","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"contactId\": \"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf\",\n \"created\": \"86b0cea0-5a80-11eb-a4f7-51ea502320d5\",\n \"dnc\": 0,\n \"timezone\": -32,\n \"extData\": {\n \"firstname\": \"John\",\n \"externalcontactkey\": \"myuniqueid\",\n \"phonenumber1\": \"+16192331234\",\n \"variablename\": \"update contact data\",\n \"lastname\": \"Tester\"\n },\n \"keys\": [\n \"+16192331234\",\n \"myuniqueid\"\n ],\n \"rmkeys\": [\n \"+17142220000\",\n \"johntester.alt@testemail.com\"\n ]\n }\n ]\n}"}],"_postman_id":"15bd7530-ddb8-4ca9-89f8-9f4849943075"},{"name":"Archive Contact","id":"066565ea-1fae-4b0b-9590-13602f679e53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v4/contact/:contactId","description":"

Deletes a contact. Like other archive endpoints there is no way to search for archived contacts.

The Contact ID of the record to archive

\n","type":"text/plain"},"type":"any","value":"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf","key":"contactId"}]}},"response":[{"id":"fde7c0b2-0386-42ea-9d8b-97f86f463021","name":"Sample Request","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v4/contact/:contactId","host":["{{url}}"],"path":["v4","contact",":contactId"],"variable":[{"key":"contactId","value":"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf","description":"The Contact ID of the record to archive"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"469","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c307\",\n \"contactId\": \"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf\",\n \"created\": \"86b0cea0-5a80-11eb-a4f7-51ea502320d5\",\n \"dnc\": 0,\n \"timezone\": -32,\n \"extData\": {\n \"firstname\": \"John\",\n \"externalcontactkey\": \"myuniqueid\",\n \"phonenumber1\": \"+16192331234\",\n \"variablename\": \"update contact data\",\n \"lastname\": \"Tester\"\n },\n \"keys\": [\n \"+16192331234\",\n \"myuniqueid\"\n ],\n \"rmkeys\": [\n \"+17142220000\",\n \"johntester.alt@testemail.com\"\n ]\n }\n ]\n}"}],"_postman_id":"066565ea-1fae-4b0b-9590-13602f679e53"},{"name":"Get Contact","id":"8030dbc1-aa5d-407b-a995-456b270a953d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/contact/:contactId/","description":"

Retrieves a contact by its contactId.

The Contact ID of the person to retrieve

\n","type":"text/plain"},"type":"any","value":"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf","key":"contactId"}]}},"response":[{"id":"12fe2c18-70c0-4fea-9824-cff85a7e71e0","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/contact/:contactId/","host":["{{url}}"],"path":["v4","contact",":contactId",""],"variable":[{"key":"contactId","value":"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf","description":"The Contact ID of the person to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"469","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c307\",\n \"contactId\": \"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf\",\n \"created\": \"86b0cea0-5a80-11eb-a4f7-51ea502320d5\",\n \"dnc\": 0,\n \"timezone\": -32,\n \"extData\": {\n \"firstname\": \"John\",\n \"externalcontactkey\": \"myuniqueid\",\n \"phonenumber1\": \"+16192331234\",\n \"variablename\": \"update contact data\",\n \"lastname\": \"Tester\"\n },\n \"keys\": [\n \"+16192331234\",\n \"myuniqueid\"\n ],\n \"rmkeys\": [\n \"+17142220000\",\n \"johntester.alt@testemail.com\"\n ]\n }\n ]\n}"}],"_postman_id":"8030dbc1-aa5d-407b-a995-456b270a953d"},{"name":"Unarchive Contact","id":"c0608c8c-d9db-4af2-ad87-c5c5acc9f6fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v4/contact/:contactId/unarchive","description":"

Returns a previously archived contact to available. If there is a key conflict this will fail.

The Contact ID of the person to unarchive

\n","type":"text/plain"},"type":"any","value":"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf","key":"contactId"}]}},"response":[{"id":"6d1d9bf9-a4ea-49a5-93b5-1bcb19d63a51","name":"Sample Request","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v4/contact/:contactId/unarchive","host":["{{url}}"],"path":["v4","contact",":contactId","unarchive"],"variable":[{"key":"contactId","value":"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf","description":"The Contact ID of the person to unarchive"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"469","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c307\",\n \"contactId\": \"c0b13242-777d-4e89-b9b2-fb5c14a1bbcf\",\n \"created\": \"86b0cea0-5a80-11eb-a4f7-51ea502320d5\",\n \"dnc\": 0,\n \"timezone\": -32,\n \"extData\": {\n \"firstname\": \"John\",\n \"externalcontactkey\": \"myuniqueid\",\n \"phonenumber1\": \"+16192331234\",\n \"variablename\": \"update contact data\",\n \"lastname\": \"Tester\"\n },\n \"keys\": [\n \"+16192331234\",\n \"myuniqueid\"\n ],\n \"rmkeys\": [\n \"+17142220000\",\n \"johntester.alt@testemail.com\"\n ]\n }\n ]\n}"}],"_postman_id":"c0608c8c-d9db-4af2-ad87-c5c5acc9f6fe"}],"id":"308c4761-3fd4-4282-a518-0f6f9b81490a","description":"

Contacts are provided as a way to store information about a user. Many of the apis can use a contact in place of a phone number because there can be additional metadata stored with the account.

This is an example contact:

{\n \"accountSid\": \"6291c31a-e7e0-499f-b720-210e4aea3745\",\n \"contactId\": \"daab0b00-631f-11ea-a59f-c5e932a2cc31\",\n \"created\": \"170a1241-0ca3-11ea-bd7e-0b63ac28d9d8\",\n \"dnc\": 0,\n \"timezone\": -32,\n \"extData\": {\n    \"firstname\": \"John\",\n    \"lastname\": \"Doe\",\n    \"phonenumber1\": \"+13105551234\",\n    \"animal\": \"cat\"\n },\n \"keys\": [\n    \"+13105551234\"\n ]\n}\n

contactId is a randomly generated UUID created at the time the contact is created.
created is a time UUID also created at the time the contact was created.
dnc tracks the \"Do Not Call\" status of a contact. A value of 1 indicates that they should not be contacted.
timezone is the calculated timezone id based upon either the contact's country and zip (preferred), or the phone number.
extData is any metadata associated with the contact.
keys are unique lookup keys. Some of these are computed based upon extData.
lastUsed, lastInbox, and lastMethod are internal values used for conversations within Inbox and are not editable fields.

ExtData

ExtData is a String:String map of additional data for the contact. Some of the fields are treated special by Ytel's systems and most of these are postfixed by the number 1. Other fields named similarly with different numerical postfixes will be subject to the same validation (if any). The keys in extData are all lowercase and will be lowercased on import.

phonenumber1 is the primary phone number and must be a valid E164 formatted number. Endpoints that use take a contactId will use this as the phone number for the call or sms. This field will be automatically populated into keys.
email1 is the primary email address. This must be formatted as an email address.
state1 is the two letter abbreviation for the US state the contact is in. International contacts should leave this blank.
zip1 is zip code of the contact.
country1 is the two letter country code of the contact.
firstname, lastname, and notes are convenience values used by the UI.

\n","_postman_id":"308c4761-3fd4-4282-a518-0f6f9b81490a","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"DNC","item":[{"name":"Add Dnc","id":"80a72161-a736-47d3-ab14-41316a89557a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"endpoint\": \"+15558675309\",\n \"selector\": \"CUSTOMER_GLOBAL\",\n \"subtype\": \"sms\",\n \"selectors\": [ \"CUSTOMER_GLOBAL\", \"+15551234567\"],\n \"subtypes\": [\"sms\", \"call\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/dnc","description":"

Add a number to your DNC that should not be contacted.

The endpoint is the phone number that should not be contacted. It should be formatted in the E164 format.

The subtype is an optional parameter for what type of contact should not be made. Valid values are sms and call, with sms being the default.

The selector is another optional parameter. This can either be an owned phone number or CUSTOMER_GLOBAL with the default being CUSTOMER_GLOBAL. Setting this value to something other than CUSTOMER_GLOBAL will only block sms/calls for the number specified.

If you need to add a DNC for both call and sms, two rows will be required.

Upload a file containing a set of numbers that should not be contacted.

The file must start with a header row. Valid headers are endpoint, subtype, and selector.

The endpoint is the phone number that should not be contacted. It should be formatted in the E164 format.

The subtype is an optional parameter for what type of contact should not be made. Valid values are sms and call, with sms being the default.

If you need to add a DNC for both call and sms, two rows will be required.

Upload a file containing a set of numbers that should not be contacted asynchronously.

The file must start with a header row. Valid headers are endpoint, subtype, and selector.

The endpoint is the phone number that should not be contacted. It should be formatted in the E164 format.

The subtype is an optional parameter for what type of contact should not be made. Valid values are sms and call, with sms being the default.

If you need to add a DNC for both call and sms, two rows will be required.

The optional callback parameter will determine which mechanism is used for sending a callback. Valid values are websocket, an id of a webhook of type api_callback, or a url.

The optional incrementalCallback parameter if set to true will result in status results while the dnc list is being processed.

Returns the DNC details for the given endpoint, selector, and subtype.

If there is not an entry for this combination it will return a standard error response indicating that the entry could not be found.

Endpoints for managing DNC (Do Not Contact) lists.

Each DNC entry has three primary attributes: endpoint, subtype, and selector.

The endpoint is the phone number that should not be contacted.

The subtype is the communication channel that is blocked. Valid values are sms, call, and bypass. Call and SMS blocking will prevent contacting a number via that contact method. The bypass subtype allows a number that is on on of Ytel's internal block lists to be contacted.

The selector is used to determine where the call or sms is not allowed to originate from. There is a special value CUSTOMER_GLOBAL that will block all outbound communication on the given channel from all owned numbers. Alternatively it can be set to an owned number.

\n","_postman_id":"747210aa-689f-48dd-9b93-3f9b739f0c57","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Inbound Routing","item":[{"name":"RouteTag","item":[{"name":"Get all RouteTags","id":"7d1b633e-80d3-4e3c-8865-6b82045cd6ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/route/tag","description":"

Returns all route tags for the account.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/route/tag/:routeTag","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","route","tag",":routeTag"],"host":["{{url}}"],"query":[],"variable":[{"id":"2722bfcc-d0b0-453d-ac26-a2837a0cdf77","type":"any","value":null,"key":"routeTag"}]}},"response":[],"_postman_id":"6b6c669a-5182-4e6f-8b3e-b4a45c28e9f5"},{"name":"Delete RouteTag","id":"238dc9ab-3274-4705-85e4-f2eb791bba41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/route/tag/:routeTag","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","route","tag",":routeTag"],"host":["{{url}}"],"query":[],"variable":[{"id":"22be4b9a-a9d5-47b5-a717-a29092fae0b9","type":"any","value":"ERER","key":"routeTag"}]}},"response":[],"_postman_id":"238dc9ab-3274-4705-85e4-f2eb791bba41"},{"name":"Add RouteTag","id":"123702ba-8400-487e-8fe1-6df8ee679177","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"routeTag\": \"buffalo\",\n \"description\": \"buffalo\",\n \"distributionType\": \"2\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/route/tag/","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","route","tag",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"123702ba-8400-487e-8fe1-6df8ee679177"},{"name":"Update RouteTag","id":"4a259ea3-4202-45cc-bc99-cfc074a0fd1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"routeTag\": \"Xmas route\",\n \"description\": \"Christmas sms list\",\n \"distributionType\": \"2\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/route/tag","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","route","tag"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a259ea3-4202-45cc-bc99-cfc074a0fd1a"},{"name":"Assign RouteTag to number(s)","id":"6c145ec0-7eaa-4476-b6f0-0186f1fbb6ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phoneNumbers\": [\"+15553497775\"],\n \"routeTag\": \"buffalo\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/route/tag/assign","description":"

Assign routeTag to a list of numbers or a numberSetId.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phoneNumbers\": [\"+15553497775\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/route/tag/assign","description":"

Remove any route tag assigned to the list of numbers or numbers assigned to a numberSetId

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/route/dest/:routeTag","description":"

Return all route destinations for the specified route tag.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"routeTag\": \"ERER\",\n \"srcType\": \"sms\",\n \"dest\": \"+15554717204\",\n \"destType\": \"call-relay\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/route/dest","description":"

Return all route destinations for the specified route tag.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/route/dest/","description":"

Return all route destinations for the specified route tag.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/route/dest/:routeTag/:sourceType/:destination/:destinationType","description":"

Return all route destinations for the specified route tag.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":" {\n \"routeTag\": \"buffalo\",\n \"scrType\": \"sms\",\n \"dest\": \"chip\",\n \"destType\": \"inbox\",\n \"name\": \"buffalo to inbox\",\n \"description\": \"\",\n \"distributionType\": 1,\n \"callbackUrl\": \"\",\n \"options\": [],\n \"applyTags\": [],\n \"priority\": 1,\n \"ruleSetId\": \"3dcde161-1b00-11ec-bfe1-d58d9b9bb3f6\",\n \"status\": 1\n }","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/route/dest","description":"

Add a new route destination for a route tag.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountSid\": \"6291c31c-e7e0-499f-b720-210e4aea3721\",\n \"routeTag\": \"callTest\",\n \"srcType\": \"call\",\n \"dest\": \"callTestXml\",\n \"destType\": \"call\",\n \"name\": \"Test inbound call xml\",\n \"created\": null,\n \"description\": \"Test inbound call\",\n \"distributionType\": 1,\n \"callbackUrl\": null,\n \"options\": {\n \"callXml\": \"http://www.moviesoundclips.net/tv1/orangeisthenewblack/freak.mp3https://webhook.site/fe693d5b-9e53-4aec-a8cb-12223\"\n },\n \"applyTags\": null,\n \"priority\": 1,\n \"ruleSetId\": \"542da420-98dd-11ec-81df-fb49300e03c2\",\n \"status\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/route/dest","description":"

Update an existing route destination

Inbound routing allows for changing destinations for incoming sms or calls based on configured criteria.

All webhooks that are configured with the type inroute will be called on each inbound call or sms to provide additional variables that can be used for routing rules. Each configured variable must be given a name and will have a value provided by a lookup into the response payload by following the JsonPath defined in the webhook variable.

\n","_postman_id":"57b5b7e4-f8ea-4c9a-a0f4-7f3bf6977999","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Inbox","item":[{"name":"Get inbox","id":"3ed35fcc-786c-43cb-b71a-985476bae721","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/inbox/?inbox={{accountsid}}","description":"

Returns the list of all conversations that had a their last publishable event during the specified time period. By default the most recent 100 events over the past 30 days.

The values in the response are as follows:

accountSid: The account id

inbox: Name of the inbox (by default this is the accountSid)

partition: Day that the event happened represented as an integer in YYYMMDD format.

time: A timeUUID for when the event happened.

timestamp: Milliseconds since the epoch for when the event happened.

contact: A snapshot of the contact object. Refer to documentation about contacts for the contents of this field.

contactId: The contactId associated with the event.

event: The body of the event. Refer to the documentation about conversations for the contents.

source: Deprecated field used for internal routing.

status: The read/unread status of an event.

open: Whether the conversation is still in an open or closed state. By default closed conversations are not returned.

type: Type of the event. This will be the same as the type within the event object.

Name of the inbox. Default inbox is the accountSid.

\n","type":"text/plain"},"key":"inbox","value":"{{accountsid}}"},{"disabled":true,"description":{"content":"

UUID of the inbox entry that all returned entries should be before.

\n","type":"text/plain"},"key":"lastTime","value":""},{"disabled":true,"description":{"content":"

Number of records to return

\n","type":"text/plain"},"key":"limit","value":"100"},{"disabled":true,"description":{"content":"

Status filter for conversations (default open)

\n","type":"text/plain"},"key":"open","value":"open"},{"disabled":true,"description":{"content":"

Earliest day of data to return.

\n","type":"text/plain"},"key":"startDate","value":""},{"disabled":true,"description":{"content":"

Last day of data to return

\n","type":"text/plain"},"key":"endDate","value":""},{"disabled":true,"description":{"content":"

Number of days of data to return

\n","type":"text/plain"},"key":"days","value":""}],"variable":[]}},"response":[{"id":"181fd3d3-f0c4-488b-9484-739bce14578a","name":"Sample Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v4/inbox/?inbox={{accountsid}}","host":["{{url}}"],"path":["v4","inbox",""],"query":[{"key":"inbox","value":"{{accountsid}}","description":"Name of the inbox. Default inbox is the accountSid."},{"key":"lastTime","value":null,"description":"UUID of the inbox entry that all returned entries should be before.\n","type":"text","disabled":true},{"key":"limit","value":"100","description":"Number of records to return","type":"text","disabled":true},{"key":"open","value":"open","description":"Status filter for conversations (default open)\n","type":"text","disabled":true},{"key":"startDate","value":null,"description":"Earliest day of data to return. ","type":"text","disabled":true},{"key":"endDate","value":null,"description":"Last day of data to return","type":"text","disabled":true},{"key":"days","value":null,"description":"Number of days of data to return","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"93334","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-RateLimit-Remaining-Second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-Second","value":"150","enabled":true},{"key":"RateLimit-Limit","value":"150","enabled":true},{"key":"RateLimit-Remaining","value":"149","enabled":true},{"key":"RateLimit-Reset","value":"1","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-Kong-Upstream-Latency","value":"62","enabled":true},{"key":"X-Kong-Proxy-Latency","value":"2","enabled":true},{"key":"Via","value":"kong/2.8.1","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c307\",\n \"inbox\": \"173c6f7f-c911-f823-fb2d-a13e4780c307\",\n \"partition\": 20221111,\n \"time\": \"db31d030-6156-11ed-8f22-3d2972e44898\",\n \"timestamp\": 1668126119091,\n \"contact\": {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c307\",\n \"contactId\": \"3f343ca7-91a8-4b03-90a7-141b26b90658\",\n \"created\": \"28874e20-cbc3-11ec-90a8-fb85a106d9fa\",\n \"lastUsed\": \"c9408680-d12f-11ec-b913-21a06f2e7cb2\",\n \"lastInbox\": \"173c6f7f-c911-f823-fb2d-a13e4780c307\",\n \"lastMethod\": \"sms\",\n \"extData\": {\n \"phonenumber1\": \"+19495551234\"\n },\n \"keys\": [\n \"+19495551234\"\n ],\n \"eventCount\": 0,\n \"dnc\": 0\n },\n \"contactId\": \"3f343ca7-91a8-4b03-90a7-141b26b90658\",\n \"event\": {\n \"body\": \"Hello world\",\n \"mediaUrl\": \"\",\n \"type\": \"sms\",\n \"messageId\": \"db31d030-6156-11ed-8f22-3d2972e44898\",\n \"direction\": \"in\",\n \"attributes\": {\n \"phonenumber1\": \"+19495551234\"\n },\n \"to\": \"+19498675309\",\n \"from\": \"+19495551234\",\n \"time\": 1668126119091\n },\n \"source\": {\n \"sourceId\": \"fsi\"\n },\n \"status\": \"unread\",\n \"open\": \"open\",\n \"type\": \"sms\"\n }\n ]\n}"}],"_postman_id":"3ed35fcc-786c-43cb-b71a-985476bae721"},{"name":"Get Inbox Names","id":"3da26774-a58f-465a-8c85-f09c5b1e2ba1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/inbox/name","description":"

Returns the list of all conversations that had a their last publishable event during the specified time period. By default the most recent 100 events over the past 30 days.

The values in the response are as follows:

accountSid: The account id

inbox: Name of the inbox (by default this is the accountSid)

partition: Day that the event happened represented as an integer in YYYMMDD format.

time: A timeUUID for when the event happened.

timestamp: Milliseconds since the epoch for when the event happened.

contact: A snapshot of the contact object. Refer to documentation about contacts for the contents of this field.

contactId: The contactId associated with the event.

event: The body of the event. Refer to the documentation about conversations for the contents.

source: Deprecated field used for internal routing.

status: The read/unread status of an event.

open: Whether the conversation is still in an open or closed state. By default closed conversations are not returned.

type: Type of the event. This will be the same as the type within the event object.

UUID of the inbox entry that all returned entries should be before.

\n","type":"text/plain"},"key":"lastTime","value":""},{"disabled":true,"description":{"content":"

Number of records to return

\n","type":"text/plain"},"key":"limit","value":"100"},{"disabled":true,"description":{"content":"

Status filter for conversations (default open)

\n","type":"text/plain"},"key":"open","value":"open"},{"disabled":true,"description":{"content":"

Earliest day of data to return.

\n","type":"text/plain"},"key":"startDate","value":""},{"disabled":true,"description":{"content":"

Last day of data to return

\n","type":"text/plain"},"key":"endDate","value":""},{"disabled":true,"description":{"content":"

Number of days of data to return

\n","type":"text/plain"},"key":"days","value":""}],"variable":[]}},"response":[],"_postman_id":"3da26774-a58f-465a-8c85-f09c5b1e2ba1"},{"name":"Update Inbox status","id":"19a8f281-4aeb-44ad-adec-019a1ef90fd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"accountSid\": \"{{accountSid}}\",\n \"inbox\": \"{{accountSid}}\",\n \"partition\": 20180620,\n \"time\": \"bdfcac40-74d1-11e8-91cc-e77ffb6be75e\",\n \"status\": \"read\",\n \"open\": \"closed\",\n \"type\": \"SMS\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/inbox","description":"

Updates the status of a conversation within the inbox. This is most typically used to mark a conversation is read by setting the status to read or to close a conversation to closed by setting the open to closed.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/conversation/?contactId=222cd43d-f4c2-4400-9e74-baa1ee4fce81","description":"

Gets the conversation involving the specified contact. If attempting to page, the lastId parameter can be used to retrieve events prior to that event.

Contact ID of the conversation you want to view

\n","type":"text/plain"},"key":"contactId","value":"222cd43d-f4c2-4400-9e74-baa1ee4fce81"},{"disabled":true,"description":{"content":"

UUID of the conversation event that all returned events will be before.

\n","type":"text/plain"},"key":"lastId","value":""},{"disabled":true,"description":{"content":"

Number of rows to return (default 1000)

\n","type":"text/plain"},"key":"size","value":""}],"variable":[]}},"response":[{"id":"bd405888-0497-421c-93b6-7716917066fb","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/conversation/?contactId=222cd43d-f4c2-4400-9e74-baa1ee4fce81","host":["{{url}}"],"path":["v4","conversation",""],"query":[{"key":"contactId","value":"222cd43d-f4c2-4400-9e74-baa1ee4fce81","description":"Contact ID of the conversation you want to view"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"31855","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"contactId\": \"222cd43d-f4c2-4400-9e74-baa1ee4fce81\",\n \"time\": \"3c044860-59ad-11eb-ba6f-89648e7154ae\",\n \"event\": {\n \"messageId\": \"3c044860-59ad-11eb-ba6f-89648e7154ae\",\n \"to\": \"+19098021234\",\n \"from\": \"411411\",\n \"direction\": \"out\",\n \"body\": \"Ytel Connect:\\nPatrick Tester\\nTest Line\\n909-802-1234\\ntest@Ytel.com\",\n \"tags\": [],\n \"attributes\": {\n \"phonenumber1\": \"+19098021234\"\n },\n \"version\": \"\",\n \"type\": \"sms\",\n \"time\": 0\n },\n \"status\": \"sent\",\n \"type\": \"sms\"\n }\n ]\n}"}],"_postman_id":"cfbab63d-00c7-4921-9c81-a0faacc57c90"},{"name":"Send Message","id":"6a9beeaf-eabb-4a29-9a19-960247d51666","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\r\n \"from\": \"+19513561234\",\r\n \"to\": \"+19492221234\",\r\n \"text\": \"Hello from inbox.\",\r\n \"source\": {\r\n \"sourceId\": \"fsi\"\r\n },\r\n \"metadata\": {\r\n \"repliedToMessageTime\": \"8f8dad90-2dcb-11eb-8aec-370be68b78ad\",\r\n \"contactId\": \"da54d682-4d48-4f13-a4ee-07c850c05bb8\",\r\n \"publish\": true\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/conversation","description":"

Sends a message to a contact over the specified channel. This is intended for use by Ytel Inbox UI. For sending SMS messages, use the general purpose SMS endpoint.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","conversation"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"53877516-c64c-4a41-9efe-185e83a91b61","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c307\",\r\n \"from\": \"+19513562111\",\r\n \"to\": \"+19495553223\",\r\n \"text\": \"Hello from inbox.\",\r\n \"source\": {\r\n \"sourceId\": \"fsi\"\r\n },\r\n \"metadata\": {\r\n \"repliedToMessageTime\": \"8f8dad90-2dcb-11eb-8aec-370be68b78ad\",\r\n \"contactId\": \"6c846983-a188-488a-a310-d20eb1ce00a9\",\r\n \"publish\": true\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/conversation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"769","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"request\": {\n \"callbackUrl\": null,\n \"detaillogResponseFormat\": \"response_format\",\n \"dlrEnabled\": true,\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"messageSid\": \"1e294460-5a95-11eb-9a67-59113aa55d66\",\n \"source\": {\n \"sourceId\": \"fsi\",\n \"clientId\": \"24554439-118f-4265-bde9-0789702990ae\"\n },\n \"from\": \"+19513561234\",\n \"numberSetId\": null,\n \"to\": \"+19492221234\",\n \"contactId\": null,\n \"text\": \"Hello from inbox.\",\n \"metadata\": {\n \"repliedToMessageTime\": \"8f8dad90-2dcb-11eb-8aec-370be68b78ad\",\n \"currentMessageTime\": null,\n \"contactId\": \"6c846983-a188-488a-a310-d20eb1ce00a9\",\n \"publish\": true,\n \"origin\": \"inbox\"\n },\n \"mediaUrl\": null,\n \"sms\": true,\n \"mms\": false\n },\n \"messageSid\": \"1e294460-5a95-11eb-9a67-59113aa55d66\",\n \"scheduledTime\": 1611088206,\n \"messageCount\": 1,\n \"responseStatus\": true\n }\n ]\n}"}],"_postman_id":"6a9beeaf-eabb-4a29-9a19-960247d51666"},{"name":"Create Inbox","id":"8180668e-9fca-47f6-96ee-4d13cab91fff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"TestBox\",\r\n \"displayName\": \"Funny Name\",\r\n \"clientIds\": [\r\n \"{{clientId}}\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/inbox/create","description":"

Sends a message to a contact over the specified channel. This is intended for use by Ytel Inbox UI. For sending SMS messages, use the general purpose SMS endpoint.

Generated using the v4 Authentication endpoint.

\n"}],"url":"{{url}}/v4/inbox/{{inboxName}}","description":"

Sends a message to a contact over the specified channel. This is intended for use by Ytel Inbox UI. For sending SMS messages, use the general purpose SMS endpoint.

Generated using the v4 Authentication endpoint.

\n"}],"body":{"mode":"raw","raw":"{\n \"accountSid\": \"{{accountSid}}\",\n \"name\": \"testbox\",\n \"displayName\": \"Funny Name\",\n \"clientIds\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/inbox/{{inboxName}}","description":"

Sends a message to a contact over the specified channel. This is intended for use by Ytel Inbox UI. For sending SMS messages, use the general purpose SMS endpoint.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactId\": \"da54d682-4d48-4f13-a4ee-07c850c05bb8\",\r\n \"from\": \"+19513561234\",\r\n \"to\": \"+19492221234\",\r\n \"notes\": \"Irate customer due to service outage. Added $50 in credit to their account.\",\r\n \"metadata\": {\r\n \"repliedToMessageTime\": \"8f8dad90-2dcb-11eb-8aec-370be68b78ad\",\r\n \"contactId\": \"da54d682-4d48-4f13-a4ee-07c850c05bb8\",\r\n \"publish\": true\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/conversation/notes","description":"

This will add inline notes into a conversation.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contactId\": \"da54d682-4d48-4f13-a4ee-07c850c05bb8\",\r\n \"from\": \"+19513561234\",\r\n \"to\": \"+19492221234\",\r\n \"description\": \"Customer form fill data\",\r\n \"url\": \"http://localhost/formFillResults?id=da54d682-4d48-4f13-a4ee-07c850c05bb8\",\r\n \"metadata\": {\r\n \"repliedToMessageTime\": \"8f8dad90-2dcb-11eb-8aec-370be68b78ad\",\r\n \"contactId\": \"da54d682-4d48-4f13-a4ee-07c850c05bb8\",\r\n \"publish\": true\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/conversation/event","description":"

This will add a link to an external event into a conversation with the provided description.

The inbox provides a way to view the conversations that an account has with their contacts. The basic GET request for an inbox will provide a preview of all recent conversations that have a publishable event. Publishable events are generally inbound communication where the contact has provided new data such as sending an inbound sms or leaving a voicemail.

An inbox conversation will be composed of one or more events detailing the various interactions that have happened with the contact. Currently the following event types are supported: sms, call, voicemail, recording, notes, and externalEvent. All events will have the following core set of fields: type, messageId, direction, tags, attributes, to, from, version, and time. The type attribute indicates which type it is. The messageId field is a unique identifier which will correlate with the relevant unique identifier for it's type (ex: messageId will be the smsSid for an sms). The direction attribute indicates whether it is inbound or outbound communication. The tags and attributes are both for metadata. The to and from fields indicate the phone numbers involved in the conversation. The version field is used to identify the version of the event (currently unused). The time is a UUID that includes the time the event happened (in many cases this will be the same as messageId).

An sms event represents an inbound or outbound sms or mms message. It will have the following additional fields: body and mediaUrl. Body will be the message body, mediaUrl will be the url for an MMS message. Generally either body or mediaUrl will be present.

A call event represents a phone call. It will have the duration field, which represents the duration of the phone call.

A voicemail event represents a voicemail. It will have the following additional fields: duration and recordingUrl. The duration is the length of the voicemail. The recordingUrl is the location where the recording is stored. Note that a voicemail recording will not include the voicemail greeting.

A recording event represents a recording of a phone call. It will have the following additional fields: duration and recordingUrl. The duration is the length of the recording. The recordingUrl is the location where the recording is stored. Recordings will include the entire length of a call.

A notes event represents conversational notes. These are intended to allow a user to add inline notes into a conversation that are not sent to a contact. It will have the notes additional field.

An externalEvent event represents an external event that is recorded in the conversation. This is intended to allow for recording of events that happen external to Ytel to be injected into a conversation. It supports the additional fields: description and url. The description is a description of the event and the url is an external url that can be followed for more information.

Websockets
One important non-http aspect of Inbox is the ability to connect to Ytel's websocket API. One can connect via:

wss://api.ytel.com/interact-websockets/ws?authtoken={access_token}&inbox={inboxName}\n\n

Once connected, this will provide a number of events that are published to that inbox. Messages will come in the format of:

{\n    \"messageType\": \"{sms | voicemail | login success}\",\n    \"messagePayloadObject\": {\n        \"accountSid\": \"{accountSid as string}\",\n        \"inboxKey\": \"{inboxName as string}\",\n        \"contactId\": \"{contactId as string}\",\n        \"status\": \"{unread | read}\",\n        \"inboxPartition\": {yyyymmdd as number},\n        \"contact\": {\n            \"contactId\": \"{contactId as string}\",\n            \"extData\": {\n                \"email1\": \"test@example.com\",\n                \"firstname\": \"Test\",\n                \"lastname\": \"User\",\n                \"phonenumber1\": \"+15558675309\"\n            },\n            \"keys\": [\n                \"+15558675309\",\n                \"test@example.com\"\n            ],\n            \"lastInbox\": \"{inboxName as string}\",\n            \"lastUsed\": \"{timeUUID as string}\"\n        },\n        \"event\": {\n            \"body\": \"This is an example sms body\",\n            \"direction\": \"{in | out}\",\n            \"mediaUrl\": \"\",\n            \"attributes\": {\n                \"phonenumber1\": \"+15558675309\"\n            },\n            \"to\": \"+15557778888\",\n            \"messageId\": \"{uuid as string}\",\n            \"from\": \"+15558675309\",\n            \"time\": 1716321152087,\n            \"type\": \"sms\"\n        },\n        \"eventId\": \"{uuid as string}\",\n        \"type\": \"sms\"\n    },\n    \"utcTimestamp\": \"{yyyy-MM-dd hh:mm:ss as string}\"\n}\n\n

","_postman_id":"811c9eda-e426-4864-9845-c677f2559d22","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"IVR","item":[{"name":"Get IVRs","id":"e89c9f73-f084-426b-bc53-4a98d0d3b258","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n"}],"url":"{{url}}/ivr/","description":"

Returns all IVR menus for the account

{\n    \"status\": true,\n    \"count\": 1,\n    \"page\": 1,\n    \"payload\": [\n        {\n            \"accountSid\": \"<UUID>\",\n            \"ivrName\": \"new-ivr\",\n            \"configurationOptions\": {\n                \"ttsVoice\": \"en-au-premium-female-1\",\n                \"maxAttempts\": 3,\n                \"timeout\": 3,\n                \"minDigits\": 1,\n                \"maxDigits\": 1,\n                \"say\": \"Overall greeting\",\n                \"play\": null,\n                \"recording\": false,\n                \"description\": \"hi\"\n            },\n            \"version\": 7,\n            \"menus\": [\n                {\n                    \"ivrName\": \"new-ivr\",\n                    \"menuId\": \"Menu 2\",\n                    \"say\": \"Menu 2\",\n                    \"play\": \"\",\n                    \"recording\": false,\n                    \"entry\": false,\n                    \"version\": 7,\n                    \"options\": [\n                        {\n                            \"say\": \"Option 1\",\n                            \"dtmfKey\": 1,\n                            \"actions\": [\n                                {\n                                    \"type\": \"say\",\n                                    \"value\": \"Action 1\"\n                                }\n                            ]\n                        }\n                    ]\n                },\n                {\n                    \"ivrName\": \"new-ivr\",\n                    \"menuId\": \"Menu 1\",\n                    \"say\": \"Menu 1\",\n                    \"play\": \"\",\n                    \"recording\": false,\n                    \"entry\": true,\n                    \"version\": 7,\n                    \"options\": [\n                        {\n                            \"say\": \"Option 1\",\n                            \"dtmfKey\": 1,\n                            \"actions\": [\n                                {\n                                    \"type\": \"say\",\n                                    \"value\": \"Action 1\"\n                                },\n                                {\n                                    \"type\": \"workflow\",\n                                    \"value\": \"<UUID>\"\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n\n

Generated using the v4 Authentication endpoint.

\n"}],"url":"{{url}}/ivr/my-ivr","description":"

Deletes an ivr menu

Generated using the v4 Authentication endpoint.

\n"}],"url":"{{url}}/ivr/my-ivr/archived","description":"

Returns the archived version of an IVR menu. This is primarily used to tie reporting statistics to older menu versions.

{\n    \"status\": true,\n    \"count\": 1,\n    \"page\": 1,\n    \"payload\": [\n        {\n            \"accountSid\": \"<UUID>\",\n            \"ivrName\": \"ff\",\n            \"configurationOptions\": {\n                \"ttsVoice\": \"de-de-premium-female-2\",\n                \"maxAttempts\": 3,\n                \"timeout\": 3,\n                \"minDigits\": 1,\n                \"maxDigits\": 1,\n                \"say\": \"ff\",\n                \"play\": null,\n                \"recording\": false,\n                \"description\": \"\"\n            },\n            \"version\": 1,\n            \"menus\": [\n                {\n                    \"ivrName\": \"ff\",\n                    \"menuId\": \"ff\",\n                    \"say\": \"f\",\n                    \"play\": \"\",\n                    \"recording\": false,\n                    \"entry\": true,\n                    \"version\": 1,\n                    \"options\": [\n                        {\n                            \"say\": \"f\",\n                            \"dtmfKey\": 1,\n                            \"actions\": [\n                                {\n                                    \"type\": \"say\",\n                                    \"value\": \"f\"\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n\n

Generated using the v4 Authentication endpoint.

\n"}],"body":{"mode":"raw","raw":"{\n \"accountSid\": \"\",\n \"ivrName\": \"ff\",\n \"configurationOptions\": {\n \"ttsVoice\": \"de-de-premium-female-2\",\n \"maxAttempts\": 3,\n \"timeout\": 3,\n \"minDigits\": 1,\n \"maxDigits\": 1,\n \"say\": \"ff\",\n \"play\": null,\n \"recording\": false,\n \"description\": \"\"\n },\n \"version\": 1,\n \"menus\": [\n {\n \"ivrName\": \"ff\",\n \"menuId\": \"ff\",\n \"say\": \"f\",\n \"play\": \"\",\n \"recording\": false,\n \"entry\": true,\n \"version\": 1,\n \"options\": [\n {\n \"say\": \"f\",\n \"dtmfKey\": 1,\n \"actions\": [\n {\n \"type\": \"say\",\n \"value\": \"f\"\n }\n ]\n }\n ]\n }\n ]\n }","options":{"raw":{"language":"json"}}},"url":"{{url}}/ivr","description":"

Creates an IVR.

Generated using the v4 Authentication endpoint.

Updates an IVR

The IVR system allows users to create an auto attendant to handle inbound phone calls with predefined options.

Key terms:

Menu - A menu within the overall IVR. Uniquely identified by the menuId.
Option - A DTMF selectable option in a single Menu. Uniquely identified by the dtmfKey.
Action - An action to be executed when an Option is selected. Has a number of subtypes that can execute different functionality. They are processed in the order they were saved. hangup and nextMenu are terminal actions that cannot have any actions following them. Subtypes:
- say - Text to speech for the provided text.
- play - Plays the provided asset.
- dial - Dials a provided phone number.
- nextMenu - Next menu to transition to when selected.
- hangup - Hangs up the call.
- workflow - Executes the selected workflow id.
\n
Version - Each IVR is versioned for reporting purposes. Any changes to an IVR menu will increment the passed version by 1 (one).
Selectable Voices - There are many voice types available for use. Please see the list below:

[\n  {\n    key: 'de-de-premium-female-1',\n    text: 'German (Germany) Premium Female 1'\n  },\n  {\n    key: 'de-de-premium-female-2',\n    text: 'German (Germany) Standard Female 2'\n  },\n  {\n    key: 'de-de-premium-male-1',\n    text: 'German (Germany) Premium Male 1'\n  },\n  {\n    key: 'de-de-premium-male-2',\n    text: 'German (Germany) Premium Male 2'\n  },\n  {\n    key: 'de-de-standard-female-1',\n    text: 'German (Germany) Standard Female 1'\n  },\n  {\n    key: 'de-de-standard-male-1',\n    text: 'German (Germany) Standard Male 1'\n  },\n  {\n    key: 'en-au-premium-female-1',\n    text: 'English (Australia) Premium Female 1'\n  },\n  {\n    key: 'en-au-premium-female-2',\n    text: 'English (Australia) Premium Female 2'\n  },\n  {\n    key: 'en-au-premium-male-1',\n    text: 'English (Australia) Premium Male 1'\n  },\n  {\n    key: 'en-au-premium-male-2',\n    text: 'English (Australia) Premium Male 2'\n  },\n  {\n    key: 'en-au-standard-female-1',\n    text: 'English (Australia) Standard Female 1'\n  },\n  {\n    key: 'en-au-standard-female-2',\n    text: 'English (Australia) Standard Female 2'\n  },\n  {\n    key: 'en-au-standard-male-1',\n    text: 'English (Australia) Standard Male 1'\n  },\n  {\n    key: 'en-au-standard-male-2',\n    text: 'English (Australia) Standard Male 2'\n  },\n  {\n    key: 'en-gb-premium-female-1',\n    text: 'English (UK) Premium Female 1'\n  },\n  {\n    key: 'en-gb-premium-female-2',\n    text: 'English (UK) Premium Female 2'\n  },\n  { key: 'en-gb-premium-male-1', text: 'English (UK) Premium Male 1' },\n  { key: 'en-gb-premium-male-2', text: 'English (UK) Premium Male 2' },\n  {\n    key: 'en-gb-standard-female-1',\n    text: 'English (UK) Standard Female 1'\n  },\n  {\n    key: 'en-gb-standard-female-2',\n    text: 'English (UK) Standard Female 2'\n  },\n  {\n    key: 'en-gb-standard-male-1',\n    text: 'English (UK) Standard Male 1'\n  },\n  {\n    key: 'en-gb-standard-male-2',\n    text: 'English (UK) Standard Male 2'\n  },\n  {\n    key: 'en-us-premium-female-1',\n    text: 'English (US) Premium Female 1'\n  },\n  {\n    key: 'en-us-premium-female-2',\n    text: 'English (US) Premium Female 2'\n  },\n  {\n    key: 'en-us-premium-female-3',\n    text: 'English (US) Premium Female 3'\n  },\n  { key: 'en-us-premium-male-1', text: 'English (US) Premium Male 1' },\n  { key: 'en-us-premium-male-2', text: 'English (US) Premium Male 2' },\n  { key: 'en-us-premium-male-3', text: 'English (US) Premium Male 3' },\n  {\n    key: 'en-us-standard-female-1',\n    text: 'English (US) Standard Female 1'\n  },\n  {\n    key: 'en-us-standard-female-2',\n    text: 'English (US) Standard Female 2'\n  },\n  {\n    key: 'en-us-standard-male-1',\n    text: 'English (US) Standard Male 1'\n  },\n  {\n    key: 'en-us-standard-male-2',\n    text: 'English (US) Standard Male 2'\n  },\n  {\n    key: 'es-es-standard-female-1',\n    text: 'Spanish (Spain) Standard Female 1'\n  },\n  {\n    key: 'fr-ca-standard-female-1',\n    text: 'French (Canada) Standard Female 1'\n  },\n  {\n    key: 'fr-ca-standard-female-2',\n    text: 'French (Canada) Standard Female 1'\n  },\n  {\n    key: 'fr-ca-standard-male-1',\n    text: 'French (Canada) Standard Male 1'\n  },\n  {\n    key: 'fr-ca-standard-male-2',\n    text: 'French (Canada) Standard Male 2'\n  },\n  {\n    key: 'fr-fr-premium-female-1',\n    text: 'French (France) Premium Female 1'\n  },\n  {\n    key: 'fr-fr-premium-female-2',\n    text: 'French (France) Premium Female 2'\n  },\n  {\n    key: 'fr-fr-premium-male-1',\n    text: 'French (France) Premium Male 1'\n  },\n  {\n    key: 'fr-fr-premium-male-2',\n    text: 'French (France) Premium Male 2'\n  },\n  {\n    key: 'fr-fr-standard-female-1',\n    text: 'French (France) Standard Female 1'\n  },\n  {\n    key: 'fr-fr-standard-female-2',\n    text: 'French (France) Standard Female 2'\n  },\n  {\n    key: 'fr-fr-standard-male-1',\n    text: 'French (France) Standard Male 1'\n  },\n  {\n    key: 'fr-fr-standard-male-2',\n    text: 'French (France) Standard Male 2'\n  },\n  { key: 'it-it-premium-female-1', text: 'Italian Premium Female 1' },\n  { key: 'it-it-standard-female-1', text: 'Italian Standard Female 1' },\n  { key: 'ja-jp-premium-female-1', text: 'Japanese Premium Female 1' },\n  {\n    key: 'ja-jp-standard-female-1',\n    text: 'Japanese Standard Female 1'\n  },\n  {\n    key: 'ko-kr-premium-female-1',\n    text: 'Korean (South Korea) Premium Female 1'\n  },\n  {\n    key: 'ko-kr-standard-female-1',\n    text: 'Korean (South Korea) Standard Female 1'\n  },\n  {\n    key: 'nl-nl-premium-female-1',\n    text: 'Dutch (Netherlands) Premimum Female 1'\n  },\n  {\n    key: 'nl-nl-standard-female-1',\n    text: 'Dutch (Netherlands) Standard Female 1'\n  },\n  {\n    key: 'pt-br-standard-female-1',\n    text: 'Portuguese (Brazil) Standard Female 1'\n  },\n  { key: 'sv-se-premium-female-1', text: 'Swedish Premium Female 1' },\n  { key: 'sv-se-standard-female-1', text: 'Swedish Standard Female 1' },\n  { key: 'tr-tr-premium-female-1', text: 'Turkish Premium Female 1' },\n  { key: 'tr-tr-standard-female-1', text: 'Turkish Standard Female 1' }\n]\n\n

","_postman_id":"b2589217-b143-402f-abfc-f3ad486109f7","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Live List","item":[{"name":"Get User Live Lists","id":"a2907426-6d0b-4731-a92f-0146686e217a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/livelist","description":"

Returns all the live lists that are accessible to the currently logged in user.

Returns the first X items that are in the live list queue without removing any of them from the queue. The returned items may be expired.

The user must either have been granted access to the list or have administrative access to lists.

Number of items to return (default 1)

\n","type":"text/plain"},"key":"size","value":"1"}],"variable":[{"id":"d111aa3f-ca1d-43e6-a8fe-f546c40cf887","type":"any","value":null,"key":"name"}]}},"response":[],"_postman_id":"cbfffc99-5863-4895-88e7-12c7fa36d611"},{"name":"Get Live List Next","id":"c72296ba-14e5-4459-9f85-04feffb92a5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/v4/livelist/queue/:name","description":"

Returns the next unexpired contact from the live list and removes it and all expired contacts before it from the list. If there are no remaining items when this is called an error will be returned.

The user must either have been granted access to the list or have administrative access to lists.

Removes the next unexpired contact from the live list and all expired contacts before it. If there are no remaining items when this is called an error will be returned.

The user must either have been granted access to the list or have administrative access to lists.

Returns all the live lists on the account with the list of users that have been assigned access to those lists.

This is only accessible to users with the account owner or settings admin roles.

Creates a new live list with the given name. The specified clientIds will be given access to the new list. The clientIds represent the ID for the Ytel users applied to the list.

This endpoint can only be accessed by users with the the account owner or settings admin roles.

Adjusts the list of users that can access the named live list.

This endpoint can only be accessed by users with the the account owner or settings admin roles.

Deletes the named live list.

This endpoint can only be accessed by users with the the account owner or settings admin roles.

The live list websocket supports subscribing to events when a live list is modified by contacts being added to the list. By default a user will be subscribed to all lists that they have access to (if the lists parameter is provided, only the provided lists will provide notifications).

Every 20-30 seconds a keep-alive message will be sent with an empty JSON object. This should be responded to with the same empty payload to keep the socket alive.

When a contact is added to a live list, the websocket will send a payload that looks like:

{\n  \"listName\": \"myFirstList\",\n  \"queueSize\": 5\n}\n\n

This message will only be sent for low queue sizes (under 10). It is expected that users that are subscribing to lists will proactively poll their subscribed lists when they are available and use this notification to be able to rapidly respond to a new contact being added to a live list.

Optional list of live lists to subscribe to. If not present it will subscribe to all lists.

\n","type":"text/plain"},"key":"lists","value":"myFirstList,mySecondList"}],"variable":[]}},"response":[],"_postman_id":"3d9399c0-1725-4289-8994-bd910a8a2a23"}],"id":"4d7bf4d8-133d-4b5c-b456-bb89f191aa1f","description":"

Live lists are a way to generate a queue of contacts that should be acted upon in a time limited manner by a specified set of users. Contacts can only be added to a live list through workflows.

Many of the endpoints may only be accessed by users with the account owner role or the settings admin role.

\n","_postman_id":"4d7bf4d8-133d-4b5c-b456-bb89f191aa1f","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Logs","item":[{"name":"Get Call Logs","id":"ecd31157-55eb-4a2b-9263-25a15237306a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"

Generated using the v4 Authentication endpoint.

\n","key":"Authorization","type":"text","value":"Bearer {Your Authentication Token}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"{{url}}/v4/logs/call/?startDate=20200301&endDate=20200302&limit=1","description":"

Retrieves the call logs between a start date and an end date.

Response Values:

accountSid: Account id
\n
yearMonthDay: Compressed year month day in the format YYYY-MM-DD.
\n
callSid: Unique transaction id of this call.
\n
apiVersion: The version of the api that was used for this call.
\n
cost: How much this particular call cost.
\n
createdTime: Time when the call was received by Ytel. This generally corresponds to the time a call was dialed.
\n
direction: inbound or outbound call.
\n
duration: Length of the call in seconds.
\n
durationBilled: Number of seconds billed for the call. This may not be the same as duration.
\n
endTime: Time that the call ended.
\n
startTime: Time that the call was answered.
\n
to: Number receiving the call. For outbound this will be the customer number, for inbound it will be the owned number.
\n
from: Number initiating the call. For outbound this will be an owned number, for inbound it will be the customer number.
\n
status: Status of the call. Possible values: completed
\n
type: Type of the call. Possible values: call
\n
voiceMailStatus: (Legacy) Not In Use
\n
date: Time that the call was initiated in seconds from the epoch.
\n

start date (UTC) formatted as YYYY-MM-DD

\n","type":"text/plain"},"key":"startDate","value":"20200301"},{"description":{"content":"

end date (UTC) formatted as YYYY-MM-DD

\n","type":"text/plain"},"key":"endDate","value":"20200302"},{"description":{"content":"

max records to return (capped at 5000)

\n","type":"text/plain"},"key":"limit","value":"1"},{"disabled":true,"description":{"content":"

optional filter to only show calls in the given direction (inbound/outbound)

\n","type":"text/plain"},"key":"direction","value":"inbound"},{"disabled":true,"description":{"content":"

optional filter to only show calls with the given status (

\n","type":"text/plain"},"key":"status","value":"completed"},{"disabled":true,"description":{"content":"

optional filter to only show calls with the given type

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

optional filter to only show calls associated with the given workflow

\n","type":"text/plain"},"key":"campaignId","value":""},{"disabled":true,"description":{"content":"

optional filter to only show calls to the given number

\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"

optional filter to only show calls from the given number

\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"

optional offset to find additional records

\n","type":"text/plain"},"key":"offset","value":""}],"variable":[]}},"response":[{"id":"0a696fb3-2500-4b1c-a533-fbcb2279eb72","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Generated using the v4 Authentication endpoint.","key":"Authorization","type":"text","value":"Bearer {Your Authentication Token}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":{"raw":"{{url}}/v4/logs/call/?startDate=2020-03-01&endDate=2020-03-02&limit=1","host":["{{url}}"],"path":["v4","logs","call",""],"query":[{"key":"startDate","value":"2020-03-01","description":"start date (UTC) formatted as YYYY-MM-DD"},{"key":"endDate","value":"2020-03-02","description":"end date (UTC) formatted as YYYY-MM-DD"},{"key":"limit","value":"1","description":"max records to return"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"522","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"yearMonthDay\": \"20200301\",\n \"callSid\": \"e0860f96-f480-43ce-bba3-2aef8d01d2b0\",\n \"apiVersion\": \"V3\",\n \"callDuration\": 8,\n \"cost\": 0.00112,\n \"createdTime\": \"2020-03-01 00:29:45\",\n \"direction\": \"inbound\",\n \"duration\": 8,\n \"durationBilled\": 12,\n \"from\": \"+15558851008\",\n \"endTime\": \"2020-03-01 00:29:53\",\n \"startTime\": \"2020-03-01 00:29:45\",\n \"status\": \"completed\",\n \"to\": \"+15559238223\",\n \"type\": \"call\",\n \"rvmCallerId\": null,\n \"voiceMailStatus\": null,\n \"date\": 1583022585565\n }\n ]\n}"}],"_postman_id":"ecd31157-55eb-4a2b-9263-25a15237306a"},{"name":"Export CDR/MDR Logs","id":"025edcc2-3b79-457f-895c-11bc24ed9689","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"test@yt-inc.com\",\n \"startdate\": \"2022-10-01\",\n \"enddate\": \"2022-10-31\",\n \"type\": \"1\"\n}"},"url":"{{url}}/v4/logs/export","description":"

Grabs all logs for the specified period and emails them to the email that is provided in the API.

The current limitations:

There is a 3 month limit on the date range.
The created logs will be deleted after 48 hours.
The API is limited to 3 request per hour.

Processing of the log files generally takes 15 seconds,

Request Values:

email: The email where logs should be sent.
startdate: Compressed year month day in the format YYYY-MM-DD.
enddate: Compressed year month day in the format YYYY-MM-DD.
type: 1 = Calls, 2 = SMS

Generated using the v4 Authentication endpoint.

Retrieves an individual call log by id.

Response Values:

accountSid: Account id
yearMonthDay: Compressed year month day in the format YYYYMMDD.
callSid: Unique transaction id of this call.
apiVersion: The version of the api that was used for this call.
cost: How much this particular call cost.
createdTime: When this row was created (generally the same as startTime)
direction: inbound or outbound call.
duration: Length of the call in seconds.
durationBilled: Number of seconds billed for the call. This may not be the same as duration.
endTime: Time that the call ended.
startTime: Time that the call was initiated.
to Number receiving the call. For outbound this will be the customer number, for inbound it will be the owned number.
from: Number initiating the call. For outbound this will be an owned number, for inbound it will be the customer number.
status: Status of the call. Possible values: completed
type: Type of the call. Possible values: call
rvmCallerId:
voiceMailStatus:
date: Time that the call was initiated in seconds from the epoch.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","logs","call","details",":callSid",""],"host":["{{url}}"],"query":[],"variable":[{"id":"90e66b71-3e1c-46d5-81ea-fca0b8815a21","type":"any","value":"24a009cb-15f9-d7f7-29e1-5f6c9a9ed4e0","key":"callSid"}]}},"response":[{"id":"27477849-22ca-4e6d-8ba5-be207a678965","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Generated using the v4 Authentication endpoint.","key":"Authorization","type":"text","value":"Bearer {Your Authentication Token}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"{{url}}/v4/logs/call/details/e0860f96-f480-43ce-bba3-2aef8d01d2b0/20200301/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"522","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"yearMonthDay\": \"20200301\",\n \"callSid\": \"e0860f96-f480-43ce-bba3-2aef8d01d2b0\",\n \"apiVersion\": \"V3\",\n \"callDuration\": 8,\n \"cost\": 0.00112,\n \"createdTime\": \"2020-03-01 00:29:45\",\n \"direction\": \"inbound\",\n \"duration\": 8,\n \"durationBilled\": 12,\n \"from\": \"+15558851008\",\n \"endTime\": \"2020-03-01 00:29:53\",\n \"startTime\": \"2020-03-01 00:29:45\",\n \"status\": \"completed\",\n \"to\": \"+15559238223\",\n \"type\": \"call\",\n \"rvmCallerId\": null,\n \"voiceMailStatus\": null,\n \"date\": 1583022585565\n }\n ]\n}"}],"_postman_id":"1f780345-49b2-4a3e-b942-b3f9617e70c1"},{"name":"Get SMS Logs","id":"fe3a68fa-c3d2-4adb-a389-0b0f92ddf7a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/logs/sms/?startDate=2021-01-09&endDate=2021-01-10&limit=1","description":"

Gets sms logs for the given time range.

Fields:

accountSid: Account Id.
yearMonthDay: Date sms was sent in YYYYMMDD format.
smsSid: Transaction id of the sms message.
apiVersion: Api version that was used for sending.
body: Body of the message
callbackMethod: Callback method (GET or POST)
callbackUrl: Url which received the callback
direction: Direction of the sms message (inbound or outbound)
dlrStatus: Status of the sms delivery.
errorMessage: Error message if any
fromCountryCode: Country code prefix for the from number.
from: From number. For inbound this will be the customer number, for outbound it will be the owned number
numberType: Type of number. Valid values are regular.
price: Price for the sms message
smsCount: Number of messages. Computed based on the length are character set.
smsType: Type of the sms. Valid values are so, si, sto, sti, sco, sci.
surcharge: Additional surcharge from the carrier.
termCarrier: Carrier from the customer number.
to: To number. For inbound this will be the owned number, for outbound this will be the customer number.
toCountryCode: Country code prefix for the to number.
useType: Regular
date: Seconds since epoch that the sms message was sent.

start date (UTC) formatted as YYYY-MM-DD

\n","type":"text/plain"},"key":"startDate","value":"2021-01-09"},{"description":{"content":"

end date (UTC) formatted as YYYY-MM-DD

\n","type":"text/plain"},"key":"endDate","value":"2021-01-10"},{"description":{"content":"

max records to return (maximum 5000)

\n","type":"text/plain"},"key":"limit","value":"1"},{"disabled":true,"description":{"content":"

optional filter to only show sms sent in one direction (inbound/outbound)

\n","type":"text/plain"},"key":"direction","value":"in"},{"disabled":true,"description":{"content":"

optional filter to only show sms with a particular status (success/failed)

\n","type":"text/plain"},"key":"status","value":"failed"},{"disabled":true,"description":{"content":"

optional filter to only show sms with a particular type (regular/tollfree)

\n","type":"text/plain"},"key":"type","value":"regular"},{"disabled":true,"description":{"content":"

optional filter to only show sms associated with a particular workflow

\n","type":"text/plain"},"key":"campaignId","value":""},{"disabled":true,"description":{"content":"

optional filter to only show sms with the given to number. Must be in E164 format.

\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"

optional filter to only show sms sent from the given number.

\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"

optional offset to find additional records

\n","type":"text/plain"},"key":"offset","value":""}],"variable":[]}},"response":[{"id":"511756e4-d953-4ff9-9eba-1a9dd530f9a6","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/logs/sms/?startDate=2021-01-09&endDate=2021-01-10&limit=1","host":["{{url}}"],"path":["v4","logs","sms",""],"query":[{"key":"startDate","value":"2021-01-09","description":"start date (UTC) formatted as YYYY-MM-DD"},{"key":"endDate","value":"2021-01-10","description":"end date (UTC) formatted as YYYY-MM-DD"},{"key":"limit","value":"1","description":"max records to return"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"836","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"yearMonthDay\": \"20210109\",\n \"smsSid\": \"af2c5810-52d6-11eb-8214-896651f1fc24\",\n \"apiVersion\": \"3\",\n \"body\": \"Testing 11456455128714554046 at 2021-01-09 11:59:13\",\n \"callbackMethod\": \"POST\",\n \"callbackUrl\": \"https://yourdomain.com\",\n \"direction\": \"inbound\",\n \"dlrStatus\": null,\n \"errorMessage\": null,\n \"fromCountryCode\": 1,\n \"fromCountry\": \"US\",\n \"from\": \"+15553518870\",\n \"numberType\": \"regular\",\n \"price\": 0,\n \"smsCount\": null,\n \"smsType\": \"si\",\n \"status\": \"success\",\n \"surcharge\": 0,\n \"termCarrier\": \"T-Mobile\",\n \"to\": \"+14009993000\",\n \"toCountryCode\": 1,\n \"toCountry\": \"US\",\n \"useType\": \"regular\",\n \"opt\": null,\n \"metaData\": {\n \"app\": \"fsi\"\n },\n \"paccountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"date\": 1610236758033\n }\n ]\n}"}],"_postman_id":"fe3a68fa-c3d2-4adb-a389-0b0f92ddf7a5"},{"name":"Get SMS Detail Log","id":"69d96840-d7d5-4002-967c-86871a202e58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/logs/sms/details/:smsSid/","description":"

Gets the details about a single sms message looked up by the message id.

The payload is essentially identical to getting a batch of sms logs by day(s).

smsSid

\n","type":"text/plain"},"type":"any","value":"af2c5810-52d6-11eb-8214-896651f1fc20","key":"smsSid"}]}},"response":[{"id":"eaf265d9-a7d3-4a64-933e-363ba32ec9cf","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/logs/sms/details/:smsSid/:date/","host":["{{url}}"],"path":["v4","logs","sms","details",":smsSid",":date",""],"variable":[{"key":"smsSid","value":"af2c5810-52d6-11eb-8214-896651f1fc24","description":"smsSid"},{"key":"date","value":"20210109","description":"date in YYYYMMDD format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"836","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"yearMonthDay\": \"20210109\",\n \"smsSid\": \"af2c5810-52d6-11eb-8214-896651f1fc24\",\n \"apiVersion\": \"3\",\n \"body\": \"Testing 11456455128714554046 at 2021-01-09 11:59:13\",\n \"callbackMethod\": \"POST\",\n \"callbackUrl\": \"https://yourdomain.com\",\n \"direction\": \"inbound\",\n \"dlrStatus\": null,\n \"errorMessage\": null,\n \"fromCountryCode\": 1,\n \"fromCountry\": \"US\",\n \"from\": \"+15553518870\",\n \"numberType\": \"regular\",\n \"price\": 0,\n \"smsCount\": null,\n \"smsType\": \"si\",\n \"status\": \"success\",\n \"surcharge\": 0,\n \"termCarrier\": \"T-Mobile\",\n \"to\": \"+14009993000\",\n \"toCountryCode\": 1,\n \"toCountry\": \"US\",\n \"useType\": \"regular\",\n \"opt\": null,\n \"metaData\": {\n \"app\": \"fsi\"\n },\n \"paccountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"date\": 1610236758033\n }\n ]\n}"}],"_postman_id":"69d96840-d7d5-4002-967c-86871a202e58"},{"name":"Call Recordings","id":"37faeb63-392d-46bd-8e47-89ecc3357f5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/logs/recording/?callSid=722e2560-f632-11ec-b1f1-8d4764fd08ab&startDate=2022-01-01&recordingSid=542e2590-f632-11ec-b1f1-8d4764fd08ak&limit=5","description":"

Returns the call recording for a particular call, recording, or date. (None of the fields are required)

NOTE: If you put a startDate with the callSid, it assumes that is the date of the call. If the callSid is the only param provided, the system will do the work to find the requested data.

The Call ID of the of the call of the recording

\n","type":"text/plain"},"key":"callSid","value":"722e2560-f632-11ec-b1f1-8d4764fd08ab"},{"description":{"content":"

The date of the call. Format YYYY-MM-DD

\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"

The Recording ID of the call

\n","type":"text/plain"},"key":"recordingSid","value":"542e2590-f632-11ec-b1f1-8d4764fd08ak"},{"description":{"content":"

The number of records to return (limit 5000)

\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"

Offset for lookup of additional records

\n","type":"text/plain"},"key":"lastCallSid","value":""}],"variable":[]}},"response":[{"id":"d426478a-f003-4d7c-b578-fc96d9ef2d78","name":"Example Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/logs/recording/?callSid=fd9173f4-d078-43c9-a61b-9c73e7c6b190&startDate=2022-06-27","host":["{{url}}"],"path":["v4","logs","recording",""],"query":[{"key":"callSid","value":"fd9173f4-d078-43c9-a61b-9c73e7c6b190","description":"The Call ID of the of the call of the recording"},{"key":"startDate","value":"2022-06-27","description":"The date of the call. Format YYYY-MM-DD"},{"key":"recordingSid","value":"542e2590-f632-11ec-b1f1-8d4764fd08ak","description":"The Recording ID of the call","disabled":true},{"key":"limit","value":"5","description":"The number of records to return","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"758","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-RateLimit-Limit-Second","value":"150","enabled":true},{"key":"RateLimit-Limit","value":"150","enabled":true},{"key":"RateLimit-Remaining","value":"149","enabled":true},{"key":"RateLimit-Reset","value":"1","enabled":true},{"key":"X-RateLimit-Remaining-Second","value":"149","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"vary","value":"Origin","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-Kong-Upstream-Latency","value":"9","enabled":true},{"key":"X-Kong-Proxy-Latency","value":"2","enabled":true},{"key":"Via","value":"kong/2.8.1","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"yearMonthDay\": \"20220627\",\n \"callSid\": \"fd9173f4-d078-43c9-a61b-9c73e7c6b19r\",\n \"recordingSid\": \"9dd1b8b0-f5ac-11ec-837e-617776b555d4\",\n \"apiVersion\": \"V3\",\n \"actionPerformed\": null,\n \"actionMethod\": null,\n \"callbackMethod\": \"POST\",\n \"callbackUrl\": \"https://api.test.com/radar/inbound/bf9c6aae-ea60-48b5e-1b3c42fed621/f611cb17-a4a6-4259-b522-d8bf78f6\",\n \"duration\": 34,\n \"fileUploadStatus\": 1,\n \"isActive\": 1,\n \"isRequest\": null,\n \"recordingDate\": 1656288192309,\n \"recordingDirection\": \"inbound\",\n \"recordingUrl\": \"https://storage.googleapis.com/m360/m360-173c6f7f-c911-f823-fb2d-a13e5c307/2022-06-27/1656288192_fd9173f4-d078-43c9-a61b-6e.mp3\",\n \"request\": null,\n \"response\": null\n }\n ]\n}"}],"_postman_id":"37faeb63-392d-46bd-8e47-89ecc3357f5f"},{"name":"Get Carrier Lookup logs","id":"339e10eb-41b3-4213-8d14-bd4f7d89c61d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/logs/carrier/?startDate=2022-01-01&endDate=2022-01-04&limit=5","description":"

Returns the carrier lookups for the given dates. (None of the fields are required)

The start date of the carrier lookups. Format YYYY-MM-DD

\n","type":"text/plain"},"key":"startDate","value":"2022-01-01"},{"description":{"content":"

The end date of the carrier lookups. Format YYYY-MM-DD

\n","type":"text/plain"},"key":"endDate","value":"2022-01-04"},{"description":{"content":"

The number of records to return (limit 5000)

\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"

Last id to be used as an offset for searching for for carrier logs

\n","type":"text/plain"},"key":"lastId","value":""}],"variable":[]}},"response":[{"id":"2b4188da-b3b7-44bc-b244-a5df39727f46","name":"Example Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint."}],"url":{"raw":"{{url}}/v4/logs/recording/?callSid=fd9173f4-d078-43c9-a61b-9c73e7c6b190&startDate=2022-06-27","host":["{{url}}"],"path":["v4","logs","recording",""],"query":[{"key":"callSid","value":"fd9173f4-d078-43c9-a61b-9c73e7c6b190","description":"The Call ID of the of the call of the recording"},{"key":"startDate","value":"2022-06-27","description":"The date of the call. Format YYYY-MM-DD"},{"key":"recordingSid","value":"542e2590-f632-11ec-b1f1-8d4764fd08ak","description":"The Recording ID of the call","disabled":true},{"key":"limit","value":"5","description":"The number of records to return","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"758"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit-Second","value":"150"},{"key":"RateLimit-Limit","value":"150"},{"key":"RateLimit-Remaining","value":"149"},{"key":"RateLimit-Reset","value":"1"},{"key":"X-RateLimit-Remaining-Second","value":"149"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Kong-Upstream-Latency","value":"9"},{"key":"X-Kong-Proxy-Latency","value":"2"},{"key":"Via","value":"kong/2.8.1"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"yearMonthDay\": \"20220627\",\n \"callSid\": \"fd9173f4-d078-43c9-a61b-9c73e7c6b19r\",\n \"recordingSid\": \"9dd1b8b0-f5ac-11ec-837e-617776b555d4\",\n \"apiVersion\": \"V3\",\n \"actionPerformed\": null,\n \"actionMethod\": null,\n \"callbackMethod\": \"POST\",\n \"callbackUrl\": \"https://api.test.com/radar/inbound/bf9c6aae-ea60-48b5e-1b3c42fed621/f611cb17-a4a6-4259-b522-d8bf78f6\",\n \"duration\": 34,\n \"fileUploadStatus\": 1,\n \"isActive\": 1,\n \"isRequest\": null,\n \"recordingDate\": 1656288192309,\n \"recordingDirection\": \"inbound\",\n \"recordingUrl\": \"https://storage.googleapis.com/m360/m360-173c6f7f-c911-f823-fb2d-a13e5c307/2022-06-27/1656288192_fd9173f4-d078-43c9-a61b-6e.mp3\",\n \"request\": null,\n \"response\": null\n }\n ]\n}"}],"_postman_id":"339e10eb-41b3-4213-8d14-bd4f7d89c61d"},{"name":"Get Debug logs","id":"8f9d50c3-825c-405e-8060-c0463c70cc82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/logs/debug/:id","description":"

This returns data that can be useful for debugging interactions that happen internal to Ytel systems for diagnosing what happened with a call, sms, or workflow.

Fields returned:
accountSid: The account id that generated this event.

uniqueId: The id of the sms, call, or individual workflow execution (campaignRunId).

data: Raw body of the event. This is generally escaped json.

level: Will always be 1.

clientId: Optional field that associates a user with the action.

type: Type of the action

date: Milliseconds since the epoch when the event happened

Returns debug logs associated with the given id. Id is typically an smsSid, callSid, or campaignRunId.

\n","type":"text/plain"},"type":"any","value":"6be998f3-d47e-4b17-b80b-0456cf070179","key":"id"}]}},"response":[{"id":"3fddfee2-c9f1-486d-bd74-5697f00812e7","name":"Get Debug logs","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url}}/v4/logs/debug/:id","host":["{{url}}"],"path":["v4","logs","debug",":id"],"variable":[{"key":"id","value":"6be998f3-d47e-4b17-b80b-0456cf070179","description":"Returns debug logs associated with the given id. Id is typically an smsSid, callSid, or campaignRunId.\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"7019","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-RateLimit-Remaining-Second","value":"99","enabled":true},{"key":"X-RateLimit-Limit-Second","value":"100","enabled":true},{"key":"RateLimit-Limit","value":"100","enabled":true},{"key":"RateLimit-Remaining","value":"99","enabled":true},{"key":"RateLimit-Reset","value":"1","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"X-Kong-Upstream-Latency","value":"8","enabled":true},{"key":"X-Kong-Proxy-Latency","value":"2","enabled":true},{"key":"Via","value":"kong/2.8.1","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 10,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"7c8693c6-976e-4324-9123-2c1d811605f9\",\n \"uniqueid\": \"b2c3f96e-608b-11ed-928b-90b11c3529e4\",\n \"data\": \"{\\\"uri\\\":\\\"https://customapps.ytel.com/m360/examples/welcome/index.php\\\",\\\"method\\\":\\\"post\\\",\\\"parameters\\\":\\\"carrier=&wireless=&zipcode=&city=&AccountSid=7c8693c6-976e-4324-9123-2c1d811605f9&From=+19792896588&To=+19792432907&CallSid=6be998f3-d47e-4b17-b80b-0456cf070179\\\"}\",\n \"level\": 1,\n \"clientId\": null,\n \"type\": \"httpreq\",\n \"date\": 1668038863426\n },\n {\n \"accountSid\": \"7c8693c6-976e-4324-9123-2c1d811605f9\",\n \"uniqueid\": \"b2cb6c30-608b-11ed-902a-77bf30607936\",\n \"data\": \"{\\\"uri\\\":\\\"https://en4zif4dskxne.x.pipedream.net/\\\",\\\"method\\\":\\\"POST\\\",\\\"headers\\\":\\\"\\\",\\\"parameters\\\":\\\"[ \\\\n {\\\\n \\\\\\\"FieldId\\\\\\\": 64,\\\\n \\\\\\\"Value\\\\\\\": \\\\\\\"{\\\\\\\"callSid\\\\\\\":\\\\\\\"6be998f3-d47e-4b17-b80b-0456cf070179\\\\\\\",\\\\\\\"apiVersion\\\\\\\":\\\\\\\"V3\\\\\\\",\\\\\\\"billCountry\\\\\\\":\\\\\\\"US\\\\\\\",\\\\\\\"callType\\\\\\\":\\\\\\\"call\\\\\\\",\\\\\\\"calledNumber\\\\\\\":\\\\\\\"+19792432907\\\\\\\",\\\\\\\"callerNumber\\\\\\\":\\\\\\\"+19792896588\\\\\\\",\\\\\\\"createdTime\\\\\\\":\\\\\\\"Nov 10, 2022, 12:07:43 AM\\\\\\\",\\\\\\\"direction\\\\\\\":\\\\\\\"inbound\\\\\\\",\\\\\\\"fromCountry\\\\\\\":\\\\\\\"US\\\\\\\",\\\\\\\"fromCountryCode\\\\\\\":1,\\\\\\\"serverIp\\\\\\\":\\\\\\\"172.21.116.12\\\\\\\",\\\\\\\"startTime\\\\\\\":\\\\\\\"Nov 10, 2022, 12:07:43 AM\\\\\\\",\\\\\\\"status\\\\\\\":\\\\\\\"in-progress\\\\\\\",\\\\\\\"toCountry\\\\\\\":\\\\\\\"US\\\\\\\",\\\\\\\"toCountryCode\\\\\\\":1}\\\\\\\"\\\\n}\\\\n]\\\"}\",\n \"level\": 1,\n \"clientId\": null,\n \"type\": \"httpreq\",\n \"date\": 1668038863475\n },\n {\n \"accountSid\": \"7c8693c6-976e-4324-9123-2c1d811605f9\",\n \"uniqueid\": \"b2d30364-608b-11ed-928b-90b11c3529e4\",\n \"data\": \"{\\\"headers\\\":\\\"text/html; charset=UTF-8\\\\r\\\",\\\"body\\\":\\\"The number you called is currently not set up. Please visit app.ytel.com to login to your account and setup your number.\\\",\\\"code\\\":\\\"200\\\"}\",\n \"level\": 1,\n \"clientId\": null,\n \"type\": \"httpresp\",\n \"date\": 1668038863524\n },\n {\n \"accountSid\": \"7c8693c6-976e-4324-9123-2c1d811605f9\",\n \"uniqueid\": \"b2d61c5c-608b-11ed-928b-90b11c3529e4\",\n \"data\": \"{\\\"action\\\":\\\"Text-To-Speech\\\",\\\"parameter\\\":\\\"Text: The number you called is currently not set up. Please visit app.ytel.com to login to your account and setup your number., Voice: , Type: ssml\\\",\\\"response\\\":\\\"Voice Used: en-us-standard-female-1\\\",\\\"actionTm\\\":1668038863545,\\\"success\\\":true}\",\n \"level\": 1,\n \"clientId\": null,\n \"type\": \"callaction\",\n \"date\": 1668038863545\n },\n {\n \"accountSid\": \"7c8693c6-976e-4324-9123-2c1d811605f9\",\n \"uniqueid\": \"b2f05950-608b-11ed-902a-77bf30607936\",\n \"data\": \"{\\\"headers\\\":\\\"date: Thu, 10 Nov 2022 00:07:43 GMT\\\\ncontent-type: application/json; charset=utf-8\\\\ncontent-length: 16\\\\nx-powered-by: Express\\\\naccess-control-allow-origin: *\\\\nx-pd-status: sent to primary\\\",\\\"body\\\":\\\" : {\\\\\\\"success\\\\\\\":true}\\\",\\\"code\\\":\\\"200\\\"}\",\n \"level\": 1,\n \"clientId\": null,\n \"type\": \"httpresp\",\n \"date\": 1668038863717\n },\n {\n \"accountSid\": \"7c8693c6-976e-4324-9123-2c1d811605f9\",\n \"uniqueid\": \"b79a483a-608b-11ed-928b-90b11c3529e4\",\n \"data\": \"{\\\"action\\\":\\\"SAY\\\",\\\"parameter\\\":\\\"Say: The number you called is currently not set up. Please visit app.ytel.com to login to your account and setup your number.\\\",\\\"response\\\":\\\"SAY Loop #: 1 of 1 elapsed time 8 no interruption\\\",\\\"actionTm\\\":1668038871541,\\\"success\\\":true}\",\n \"level\": 1,\n \"clientId\": null,\n \"type\": \"callaction\",\n \"date\": 1668038871541\n },\n {\n \"accountSid\": \"7c8693c6-976e-4324-9123-2c1d811605f9\",\n \"uniqueid\": \"b7a52ed0-608b-11ed-902a-77bf30607936\",\n \"data\": \"{\\\"uri\\\":\\\"https://en4zif4dskxne.x.pipedream.net/\\\",\\\"method\\\":\\\"POST\\\",\\\"headers\\\":\\\"\\\",\\\"parameters\\\":\\\"[ \\\\n {\\\\n \\\\\\\"FieldId\\\\\\\": 64,\\\\n \\\\\\\"Value\\\\\\\": \\\\\\\"{\\\\\\\"callSid\\\\\\\":\\\\\\\"6be998f3-d47e-4b17-b80b-0456cf070179\\\\\\\",\\\\\\\"apiVersion\\\\\\\":\\\\\\\"V3\\\\\\\",\\\\\\\"billCountry\\\\\\\":\\\\\\\"US\\\\\\\",\\\\\\\"callType\\\\\\\":\\\\\\\"call\\\\\\\",\\\\\\\"calledNumber\\\\\\\":\\\\\\\"+19792432907\\\\\\\",\\\\\\\"callerNumber\\\\\\\":\\\\\\\"+19792896588\\\\\\\",\\\\\\\"createdTime\\\\\\\":\\\\\\\"Nov 10, 2022, 12:07:43 AM\\\\\\\",\\\\\\\"direction\\\\\\\":\\\\\\\"inbound\\\\\\\",\\\\\\\"duration\\\\\\\":8,\\\\\\\"endTime\\\\\\\":\\\\\\\"Nov 10, 2022, 12:07:51 AM\\\\\\\",\\\\\\\"fromCountry\\\\\\\":\\\\\\\"US\\\\\\\",\\\\\\\"fromCountryCode\\\\\\\":1,\\\\\\\"serverIp\\\\\\\":\\\\\\\"172.21.116.12\\\\\\\",\\\\\\\"startTime\\\\\\\":\\\\\\\"Nov 10, 2022, 12:07:43 AM\\\\\\\",\\\\\\\"status\\\\\\\":\\\\\\\"completed\\\\\\\",\\\\\\\"toCountry\\\\\\\":\\\\\\\"US\\\\\\\",\\\\\\\"toCountryCode\\\\\\\":1,\\\\\\\"hangupBy\\\\\\\":\\\\\\\"TERMINATOR END\\\\\\\",\\\\\\\"metadata\\\\\\\":{}}\\\\\\\"\\\\n}\\\\n]\\\"}\",\n \"level\": 1,\n \"clientId\": null,\n \"type\": \"httpreq\",\n \"date\": 1668038871613\n },\n {\n \"accountSid\": \"7c8693c6-976e-4324-9123-2c1d811605f9\",\n \"uniqueid\": \"b7a57cf0-608b-11ed-902a-77bf30607936\",\n \"data\": \"{\\\"uri\\\":\\\"https://api.airtable.com/v0/appdKJrvVfWlE17DQ/Table%201\\\",\\\"method\\\":\\\"POST\\\",\\\"headers\\\":\\\"Authorization: Token\\\\nContent-Type: application/json\\\",\\\"parameters\\\":\\\"{\\\\n \\\\\\\"records\\\\\\\": [\\\\n {\\\\n \\\\\\\"fields\\\\\\\": {\\\\n\\\\\\\"callsid\\\\\\\": \\\\\\\"6be998f3-d47e-4b17-b80b-0456cf070179\\\\\\\",\\\\n\\\\\\\"calltype\\\\\\\": \\\\\\\"call\\\\\\\",\\\\n\\\\\\\"duration\\\\\\\": \\\\\\\"8\\\\\\\",\\\\n\\\\\\\"callednumber\\\\\\\": \\\\\\\"+19792432907\\\\\\\",\\\\n\\\\\\\"callernumber\\\\\\\": \\\\\\\"+19792896588\\\\\\\",\\\\n\\\\\\\"apiversion\\\\\\\": \\\\\\\"V3\\\\\\\",\\\\n\\\\\\\"billcountry\\\\\\\": \\\\\\\"US\\\\\\\",\\\\n\\\\\\\"createdtime\\\\\\\": \\\\\\\"2022-11-10T00:07:43+0000\\\\\\\",\\\\n\\\\\\\"dtmfentered\\\\\\\": \\\\\\\"%DTMFENTERED%\\\\\\\"\\\\n}\\\\n }\\\\n ]\\\\n}\\\"}\",\n \"level\": 1,\n \"clientId\": null,\n \"type\": \"httpreq\",\n \"date\": 1668038871615\n },\n {\n \"accountSid\": \"7c8693c6-976e-4324-9123-2c1d811605f9\",\n \"uniqueid\": \"b7bc1230-608b-11ed-902a-77bf30607936\",\n \"data\": \"{\\\"headers\\\":\\\"date: Thu, 10 Nov 2022 00:07:51 GMT\\\\ncontent-type: application/json; charset=utf-8\\\\ncontent-length: 16\\\\nx-powered-by: Express\\\\naccess-control-allow-origin: *\\\\nx-pd-status: sent to primary\\\",\\\"body\\\":\\\" : {\\\\\\\"success\\\\\\\":true}\\\",\\\"code\\\":\\\"200\\\"}\",\n \"level\": 1,\n \"clientId\": null,\n \"type\": \"httpresp\",\n \"date\": 1668038871763\n },\n {\n \"accountSid\": \"7c8693c6-976e-4324-9123-2c1d811605f9\",\n \"uniqueid\": \"b8ec54d0-608b-11ed-902a-77bf30607936\",\n \"data\": \"{\\\"headers\\\":\\\"access-control-allow-headers: authorization,content-length,content-type,user-agent,x-airtable-application-id,x-airtable-user-agent,x-api-version,x-requested-with\\\\naccess-control-allow-methods: DELETE,GET,OPTIONS,PATCH,POST,PUT\\\\naccess-control-allow-origin: *\\\\nairtable-uncompressed-content-length: 342\\\\nContent-Type: application/json; charset=utf-8\\\\nDate: Thu, 10 Nov 2022 00:07:53 GMT\\\\nServer: Tengine\\\\nSet-Cookie: brw=brwCqSMGgx4iGgb5h; path=/; expires=Fri, 10 Nov 2023 00:07:51 GMT; domain=.airtable.com; samesite=none; secure\\\\nStrict-Transport-Security: max-age=31536000; includeSubDomains; preload\\\\nVary: Accept-Encoding\\\\nX-Content-Type-Options: nosniff\\\\nX-Frame-Options: DENY\\\\nContent-Length: 342\\\\nConnection: keep-alive\\\",\\\"body\\\":\\\" : {\\\\\\\"records\\\\\\\":[{\\\\\\\"id\\\\\\\":\\\\\\\"recIz6MrDMN1bOK9b\\\\\\\",\\\\\\\"createdTime\\\\\\\":\\\\\\\"2022-11-10T00:07:52.000Z\\\\\\\",\\\\\\\"fields\\\\\\\":{\\\\\\\"callsid\\\\\\\":\\\\\\\"6be998f3-d47e-4b17-b80b-0456cf070179\\\\\\\",\\\\\\\"calltype\\\\\\\":\\\\\\\"call\\\\\\\",\\\\\\\"duration\\\\\\\":\\\\\\\"8\\\\\\\",\\\\\\\"callednumber\\\\\\\":\\\\\\\"+19792432907\\\\\\\",\\\\\\\"callernumber\\\\\\\":\\\\\\\"+19792896588\\\\\\\",\\\\\\\"apiversion\\\\\\\":\\\\\\\"V3\\\\\\\",\\\\\\\"billcountry\\\\\\\":\\\\\\\"US\\\\\\\",\\\\\\\"createdtime\\\\\\\":\\\\\\\"2022-11-10T00:07:43+0000\\\\\\\",\\\\\\\"dtmfentered\\\\\\\":\\\\\\\"%DTMFENTERED%\\\\\\\"}}]}\\\",\\\"code\\\":\\\"200\\\"}\",\n \"level\": 1,\n \"clientId\": null,\n \"type\": \"httpresp\",\n \"date\": 1668038873757\n }\n ]\n}"}],"_postman_id":"8f9d50c3-825c-405e-8060-c0463c70cc82"}],"id":"c1f28e07-eb18-4580-b9f7-aea76a066024","description":"

The logs endpoints exist to allow users to get the transactional logs of each billable request by time in a date range.

Note: 13 months of data is being stored for Call Logs and SMS logs

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ab61f5fa-36c6-4125-8db5-1680c48258d3"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ce10d851-ce99-4039-b421-c86e557ff37e"}}],"_postman_id":"c1f28e07-eb18-4580-b9f7-aea76a066024","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Numbers","item":[{"name":"Get Numbers","id":"4179d026-5171-4cfe-a3ce-a6d8a0d12a6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/number/?nextKey=KzE5NDk1NTU0NDQ0&size=100","description":"

Retrieves numbers on the account.

Fields:

accountSid: Account id
\n
phoneSid: Unique id for this phone number
\n
phoneNumber: Phone number for this record in E164 format.
\n
voiceUrl: Url to hit when an inbound voice call is received.
\n
voiceMethod: HTTP method to use in conjunction with the voiceUrl. Valid values GET and POST.
\n
voiceFallbackUrl: Url to use if voiceUrl fails.
\n
voiceFallbackMethod: HTTP method for voiceFallbackUrl.
\n
smsUrl: Url to hit when an inbound sms is received.
\n
smsMethod: HTTP method to use with smsUrl.
\n
smsFallbackUrl: Url to hit if smsUrl fails.
\n
smsFallbackMethod: HTTP method for smsFallbackUrl.
\n
heartbeatUrl: Url to hit for heartbeat messages.
\n
heartbeatMethod: HTTP method for heartbeatUrl.
\n
hangupCallbackUrl: Url to hit when a call is completed.
\n
hangupCallbackMethod: HTTP method for hangupCallbackUrl.
\n
renewalDate: Next time that this number will be billed. Milliseconds from the epoch.
\n
purchaseDate: Time the number was purchased. Milliseconds from the epoch.
\n
region: Where the number is based based on prefix. Format is Country-State (or Province).
\n
timezone: Timezone id where the number is based.
\n
numberSetId: Number set that this number belongs to.
\n
attributes: List of attributes for the number. Current set is voice-enabled, sms-enabled, and mms-enabled.
\n
numberType: Type of the number.
\n
keywordActions: A mapping of actions to take when a particular keyword is received. Currently this only supports starting a campaign.
\n

base64 encoded phone number (E.164 format) the record should start with

\n","type":"text/plain"},"key":"nextKey","value":"KzE5NDk1NTU0NDQ0"},{"description":{"content":"

Number of records to return

\n","type":"text/plain"},"key":"size","value":"100"}],"variable":[]}},"response":[{"id":"abe1c035-68cb-46cb-a9ea-1c243d891fc2","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/number/?offset=0","host":["{{url}}"],"path":["v4","number",""],"query":[{"key":"offset","value":"0","description":"The record to start with"},{"key":"pageSize","value":"1","description":"Number of records to return","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"361748","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 576,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"phoneSid\": \"25431e50-6866-11ea-9ea9-d1464f98b813\",\n \"phoneNumber\": \"+15552283797\",\n \"voiceUrl\": \"https://testdomain.com\",\n \"voiceMethod\": \"GET\",\n \"voiceFallbackUrl\": \"\",\n \"voiceFallbackMethod\": \"POST\",\n \"renewalDate\": 1611101028432,\n \"purchaseDate\": 1584459850921,\n \"region\": \"US-NJ\",\n \"timezone\": -20,\n \"smsUrl\": \"\",\n \"smsMethod\": \"POST\",\n \"smsFallbackUrl\": \"\",\n \"smsFallbackMethod\": \"POST\",\n \"heartbeatUrl\": \"\",\n \"heartbeatMethod\": \"POST\",\n \"hangupCallbackUrl\": \"\",\n \"hangupCallbackMethod\": \"POST\",\n \"attributes\": [\n \"voice-enabled\"\n ],\n \"numberType\": 1\n },\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"phoneSid\": \"8567a510-6886-11ea-9b6f-e6478104197e\",\n \"phoneNumber\": \"+15552283811\",\n \"voiceUrl\": \"https://testdomain.com\",\n \"voiceMethod\": \"GET\",\n \"voiceFallbackUrl\": \"\",\n \"voiceFallbackMethod\": \"POST\",\n \"renewalDate\": 1611360251655,\n \"purchaseDate\": 1584473756124,\n \"region\": \"US-NJ\",\n \"timezone\": -20,\n \"smsUrl\": \"\",\n \"smsMethod\": \"POST\",\n \"smsFallbackUrl\": \"\",\n \"smsFallbackMethod\": \"POST\",\n \"heartbeatUrl\": \"\",\n \"heartbeatMethod\": \"POST\",\n \"hangupCallbackUrl\": \"\",\n \"hangupCallbackMethod\": \"POST\",\n \"attributes\": [\n \"voice-enabled\"\n ],\n \"numberType\": 1\n }\n ]\n}"}],"_postman_id":"4179d026-5171-4cfe-a3ce-a6d8a0d12a6f"},{"name":"Get Available Numbers","id":"58d4fecb-b43b-4c8f-a060-515feabd1c0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/number/available/?areaCode=714&offset=0&size=3","description":"

Gets a list of available voice enabled numbers for purchase. All voice enabled number can be SMS enabled through Campaign Registry (long code) and Verified Sender (toll-free).

Parameters:

areaCode: all or a comma separated list of area codes (ex: 213,714,619)
\n
offset: unused
\n
size: Number of results per area code. Default 20.
\n

Response

phoneNumber: Phone number that is available for purchase.
\n
region: Region where the number is associated with. Based on the prefix of the number.
\n
timezone: Timezone id for the phone number.
\n
attributes: List of attributes. Valid values are voice-enabled, sms-enabled, mms-enabled.
\n

comma separated list of area codes or all for all

\n","type":"text/plain"},"key":"areaCode","value":"714"},{"description":{"content":"

offset

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

number of results to return per area code

\n","type":"text/plain"},"key":"size","value":"3"}],"variable":[]}},"response":[{"id":"5e8cb5aa-a7c3-48ca-9599-715614dc6578","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/number/available/?areaCode=714&offset=0&size=3&type=sms","host":["{{url}}"],"path":["v4","number","available",""],"query":[{"key":"areaCode","value":"714","description":"comma separated list of area codes or `all` for all"},{"key":"offset","value":"0","description":"The record index to start listing at"},{"key":"size","value":"3","description":"The number of results to return per area code"},{"key":"type","value":"sms","description":"The type of number to return (sms, voice, tollfree)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"429","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 3,\n \"page\": 1,\n \"payload\": [\n {\n \"phoneNumber\": \"+17142421234\",\n \"region\": \"US-CA\",\n \"timezone\": -32,\n \"attributes\": [\n \"voice-enabled\",\n \"sms-enabled\"\n ],\n \"numberType\": 1\n },\n {\n \"phoneNumber\": \"+17144061234\",\n \"region\": \"US-CA\",\n \"timezone\": -32,\n \"attributes\": [\n \"mms-enabled\",\n \"voice-enabled\",\n \"sms-enabled\"\n ],\n \"numberType\": 1\n },\n {\n \"phoneNumber\": \"+17142421234\",\n \"region\": \"US-CA\",\n \"timezone\": -32,\n \"attributes\": [\n \"voice-enabled\",\n \"sms-enabled\"\n ],\n \"numberType\": 1\n }\n ]\n}"}],"_postman_id":"58d4fecb-b43b-4c8f-a060-515feabd1c0b"},{"name":"Purchase Number","id":"09b986ba-4911-4e41-8db1-03de9eca344b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"numberSetId\": \"b33f7d40-79b7-11ea-af46-7330668f35a8\",\r\n \"phoneNumber\": [\r\n \"+17142421234\"\r\n ]\r\n}"},"url":"{{url}}/v4/number/purchase/","description":"

Purchase a list of phone numbers. If using a number set, all the newly purchased numbers will be configured with the settings of the number set. A subsequent call to edit the number to configure them is not necessary.

Request fields:

phoneNumber: List of numbers to purchase in E164 format.
numberSetId: Optional number set id that all newly purchased numbers will be added to.

Response will be the configuration for the newly purchased number. Refer to the documentation for Get Number for the response data.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumber\": [\r\n \"+12012281234\"\r\n ]\r\n}"},"url":"{{url}}/v4/number/release/","description":"

Release ownership of a set of numbers.

The payload for the response will be the previous configuration for the released numbers.

Array maximum is 100

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumbers\": [\r\n \"+19892001234\"\r\n ],\r\n \"toAccountSid\": \"1e091839-3b9c-fe2e-1e5a-de6b748d8ff0\", \r\n \"fromAccountSid\" : \"173c6f7f-c911-f823-fb2d-a13e4780c300\"\r\n}"},"url":"{{url}}/v4/number/transfer/","description":"

Transfer numbers from this account to a subaccount (if a parent account) or to a parent account (if a subaccount). To transfer numbers from one subaccount to another subaccount they must first be transferred to the parent and then to the other subaccount.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","number","transfer",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"dab8c92a-2cfb-4686-b845-0b5983f66b5e","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phoneNumbers\": [\r\n \"+19892001234\"\r\n ],\r\n \"toAccountSid\": \"1e091839-3b9c-fe2e-1e5a-de6b748d8ff0\", \r\n \"fromAccountSid\" : \"173c6f7f-c911-f823-fb2d-a13e4780c300\"\r\n}"},"url":"{{url}}/v4/number/transfer/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1464","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"1e091839-3b9c-fe2e-1e5a-de6b748d8ff0\",\n \"phoneSid\": \"ae03cf50-4d27-11ea-a29d-d764c8e68237\",\n \"friendlyName\": \"
\",\n \"phoneNumber\": \"+19892001234\",\n \"voiceUrl\": \"https://testdomain.com\",\n \"voiceMethod\": \"GET\",\n \"voiceFallbackUrl\": \"\",\n \"voiceFallbackMethod\": \"POST\",\n \"renewalDate\": 1610669135164,\n \"purchaseDate\": 1581464340671,\n \"region\": \"US-MI\",\n \"timezone\": -20,\n \"smsUrl\": \"\",\n \"smsMethod\": \"POST\",\n \"smsFallbackUrl\": \"\",\n \"smsFallbackMethod\": \"POST\",\n \"heartbeatUrl\": \"\",\n \"heartbeatMethod\": \"POST\",\n \"hangupCallbackUrl\": \"\",\n \"hangupCallbackMethod\": \"POST\",\n \"attributes\": [\n \"voice-enabled\"\n ],\n \"numberType\": 1\n }\n ],\n \"error\": []\n}"}],"_postman_id":"eeba675b-88d9-485f-a26f-11c12e8a0f56"},{"name":"Get Number","id":"252a7ce4-1ba0-4998-b727-7e32ebbf7a97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/number/:phoneNumber/","description":"

Retrieves the details for a single number in E164 format.

The phone number to retrieve information on

\n","type":"text/plain"},"type":"any","value":"+19712201234","key":"phoneNumber"}]}},"response":[{"id":"cbf7dad7-e0c5-4711-ab09-fe0c83570f33","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint."}],"url":{"raw":"{{url}}/v4/number/:phoneNumber/","host":["{{url}}"],"path":["v4","number",":phoneNumber",""],"variable":[{"key":"phoneNumber","value":"+19495065906","description":"The phone number to retrieve information on"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1194"},{"key":"Connection","value":"keep-alive"},{"key":"RateLimit-Limit","value":"150"},{"key":"RateLimit-Remaining","value":"149"},{"key":"RateLimit-Reset","value":"1"},{"key":"X-RateLimit-Remaining-Second","value":"149"},{"key":"X-RateLimit-Limit-Second","value":"150"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-Kong-Upstream-Latency","value":"22"},{"key":"X-Kong-Proxy-Latency","value":"3"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fn2d-a13e4780c300\",\n \"phoneSid\": \"e2c28d1d-b290-e7ab-3d38-caa585427859\",\n \"friendlyName\": \"Number Name\",\n \"phoneNumber\": \"+19495065906\",\n \"voiceUrl\": \"https:/test.com\",\n \"cnam\": \"\",\n \"countryName\": \"US\",\n \"voiceMethod\": \"POST\",\n \"voiceFallbackUrl\": \"\",\n \"voiceFallbackMethod\": \"POST\",\n \"renewalDate\": 1696118400000,\n \"purchaseDate\": 1539987416358,\n \"region\": \"US-CA\",\n \"timezone\": -32,\n \"smsUrl\": \"http://my.host.com/sms\",\n \"smsMethod\": \"POST\",\n \"smsFallbackUrl\": \"http://my.host2.com/sm\",\n \"smsFallbackMethod\": \"POST\",\n \"heartbeatUrl\": \"\",\n \"heartbeatMethod\": \"GET\",\n \"hangupCallbackUrl\": \"https://host.com\",\n \"hangupCallbackMethod\": \"POST\",\n \"reputationResults\": {},\n \"ftcComplaintCount\": 0,\n \"branded\": false,\n \"remediation\": false,\n \"attributes\": [\n \"voice-enabled\"\n ],\n \"numberType\": 1\n }\n ]\n}"}],"_postman_id":"252a7ce4-1ba0-4998-b727-7e32ebbf7a97"},{"name":"Edit Number","id":"347889e5-86a4-4fe7-a4d7-7f76d63b7907","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"friendlyName\": \"My Number\",\r\n \"hangupCallbackMethod\": \"POST\",\r\n \"hangupCallbackUrl\": \"http://my.host.com/hangup\",\r\n \"heartbeatMethod\": \"GET\",\r\n \"heartbeatUrl\": \"http://my.host.com/heartbeat\",\r\n \"smsMethod\": \"POST\",\r\n \"smsUrl\": \"http://my.host.com/sms\",\r\n \"smsFallbackMethod\": \"POST\",\r\n \"smsFallbackUrl\": \"http://my.host2.com/sms\",\r\n \"voiceMethod\": \"POST\",\r\n \"voiceUrl\": \"http://my.host.com/voice\",\r\n \"voiceFallbackMethod\": \"POST\",\r\n \"voiceFallbackUrl\": \"http://my.host2.com/voice\"\r\n}"},"url":"{{url}}/v4/number/:phoneNumber/","description":"

Edit the configuration for a number. For numbers that are in a number set changes made here will be overridden if the number set is edited. It is highly recommended to not use this endpoint for numbers in a number set.

Editable Items:

friendlyName
hangupCallbackUrl and hangupCallbackMethod
heartbeatUrl and heartbeatMethod
voiceUrl and voiceMethod
voiceFallbackUrl and voiceFallbackMethod
smsUrl and smsMethod
smsFallbackUrl and smsFallbackMethod

phoneNumber

\n","type":"text/plain"},"type":"any","value":"+19892008187","key":"phoneNumber"}]}},"response":[{"id":"a7a6bbe7-3d65-4809-8b61-60d43a0d9324","name":"Sample Request","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"friendlyName\": \"My Number\",\r\n \"hangupCallbackMethod\": \"POST\",\r\n \"hangupCallbackUrl\": \"http://my.host.com/hangup\",\r\n \"heartbeatMethod\": \"GET\",\r\n \"heartbeatUrl\": \"http://my.host.com/heartbeat\",\r\n \"smsMethod\": \"POST\",\r\n \"smsUrl\": \"http://my.host.com/sms\",\r\n \"smsFallbackMethod\": \"POST\",\r\n \"smsFallbackUrl\": \"http://my.host2.com/sms\",\r\n \"voiceMethod\": \"POST\",\r\n \"voiceUrl\": \"http://my.host.com/voice\",\r\n \"voiceFallbackMethod\": \"POST\",\r\n \"voiceFallbackUrl\": \"http://my.host2.com/voice\"\r\n}"},"url":{"raw":"{{url}}/v4/number/:phoneNumber/","host":["{{url}}"],"path":["v4","number",":phoneNumber",""],"variable":[{"key":"phoneNumber","value":"+19892001234","description":"phoneNumber"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"655","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"phoneSid\": \"86c63570-58f5-11ea-8a00-1d419766bdd1\",\n \"friendlyName\": \"My Number\",\n \"phoneNumber\": \"+19892001234\",\n \"voiceUrl\": \"http://my.host.com/voice\",\n \"voiceMethod\": \"POST\",\n \"voiceFallbackUrl\": \"http://my.host2.com/voice\",\n \"voiceFallbackMethod\": \"POST\",\n \"renewalDate\": 1612224248287,\n \"smsUrl\": \"http://my.host.com/sms\",\n \"smsMethod\": \"POST\",\n \"smsFallbackUrl\": \"http://my.host2.com/sms\",\n \"smsFallbackMethod\": \"POST\",\n \"heartbeatUrl\": \"http://my.host.com/heartbeat\",\n \"heartbeatMethod\": \"GET\",\n \"hangupCallbackUrl\": \"http://my.host.com/hangup\",\n \"hangupCallbackMethod\": \"POST\",\n \"numberType\": 1\n }\n ]\n}"}],"_postman_id":"347889e5-86a4-4fe7-a4d7-7f76d63b7907"},{"name":"Assign WebRTC Number","id":"02a19255-9f37-494e-bbe3-4f2508bd6442","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\"phoneNumber\":\"{{fromnumber}}\"}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/number/webrtc/","description":"

The number in your account to assign to your WebRTC user.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","number","webrtc",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"654fd263-193c-4b7a-a388-514289e38ab1","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\"phoneNumber\":\"+12513561234\"}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/number/webrtc/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1053","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"phoneSid\": \"13b22270-a29c-11e9-80d2-2d4429cd4b11\",\n \"assignedUser\": \"24554439-118f-4265-bde9-0789702990ac\",\n \"friendlyName\": \"Test Number\",\n \"phoneNumber\": \"+12513561234\",\n \"voiceUrl\": \"https://www.ytel.com/0bb882e9-1406-4d75-a2ca-test.xml\",\n \"voiceMethod\": \"GET\",\n \"voiceFallbackUrl\": \"\",\n \"voiceFallbackMethod\": \"POST\",\n \"renewalDate\": 1627257825840,\n \"purchaseDate\": 1562712684047,\n \"region\": \"US-CA\",\n \"timezone\": -32,\n \"smsUrl\": \"\",\n \"smsMethod\": \"POST\",\n \"smsFallbackUrl\": \"\",\n \"smsFallbackMethod\": \"POST\",\n \"heartbeatUrl\": \"\",\n \"heartbeatMethod\": \"POST\",\n \"hangupCallbackUrl\": \"\",\n \"hangupCallbackMethod\": \"POST\",\n \"attributes\": [\n \"voice-enabled\",\n \"sms-enabled\"\n ],\n \"numberType\": 1\n }\n ]\n}"}],"_postman_id":"02a19255-9f37-494e-bbe3-4f2508bd6442"}],"id":"024b3ad8-d552-4d56-8bb1-0d625bc9b348","description":"

Controls for adding, editing, and releasing numbers on an account.

\n","_postman_id":"024b3ad8-d552-4d56-8bb1-0d625bc9b348","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Dispositions","item":[{"name":"Get Dispositions","id":"86ef5625-467f-4a15-b927-ff8176d0211f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/disposition","description":"

Retrieves all dispositions in the system.

Adds a new disposition.

Editss an existing disposition. If editing a default disposition only the triggeredCampaignId may be set.

Dispositions are used to annotate how a call or conversation has been concluded. There are some system default dispositions that cannot be modified with the exception of assigning a workflow to them to be triggered when a disposition is assigned.

Fields in a disposition:

accountSid: Associate account Id
key: Unique identifier for the disposition
description: User visible description of the disposition
tags: List of tags that are associated with the disposition. Valid tags are: human, sale, dnc, contact, not interested, unworkable, callback, completed, answering machine.
direction: Directions that are applicable for assignment of a disposition. Valid directions are: inbound, outbound, both.
triggeredCampaignId: Workflow that should be triggered when this disposition is assigned.

\n","_postman_id":"fbdd6959-e6d4-4107-8fda-2c8b6d5d6271","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Number Sets","item":[{"name":"Get Number Sets","id":"91701a3e-f5da-426d-b35b-d35733c9e11d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/numberset/","description":"

Retrieves all the number sets associated with this account.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\r\n \"name\": \"My number set\",\r\n \"numberSetId\": \"\",\r\n \"voiceUrl\": \"http://my.host.com/voice\",\r\n \"voiceMethod\": \"POST\",\r\n \"voiceFallbackUrl\": \"http://my.host2.com/voice\",\r\n \"voiceFallbackMethod\": \"POST\",\r\n \"hangupCallbackUrl\": \"http://my.host.com/hangup\",\r\n \"hangupCallbackMethod\": \"POST\",\r\n \"heartbeatUrl\": \"http://my.host.com/heartbeat\",\r\n \"heartbeatMethod\": \"POST\",\r\n \"smsUrl\": \"http://my.host.com/sms\",\r\n \"smsFallbackUrl\": \"http://my.host2.com/sms\",\r\n \"smsFallbackMethod\": \"POST\",\r\n \"phoneNumbers\": [\r\n \"+19892001234\"\r\n ],\r\n \"keywordActions\": {\r\n \"HI\": {\r\n \"campaignId\": \"e8861980-5165-11e9-b3b4-55cdbe9b37b5\"\r\n }\r\n }\r\n}"},"url":"{{url}}/v4/numberset/","description":"

Creates a new number set. If a list of phone numbers is provided in the payload they will be added to the number set.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","numberset",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4b801811-cf20-41dc-9f76-af2cd26a9265","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\r\n \"forwardNumber\": \"\",\r\n \"callerIdName\": \"\",\r\n \"name\": \"My number set\",\r\n \"numberSetId\": \"\",\r\n \"voiceUrl\": \"http://my.host.com/voice\",\r\n \"voiceMethod\": \"POST\",\r\n \"voiceFallbackUrl\": \"http://my.host2.com/voice\",\r\n \"voiceFallbackMethod\": \"POST\",\r\n \"hangupCallbackUrl\": \"http://my.host.com/hangup\",\r\n \"hangupCallbackMethod\": \"POST\",\r\n \"heartbeatUrl\": \"http://my.host.com/heartbeat\",\r\n \"heartbeatMethod\": \"POST\",\r\n \"smsUrl\": \"http://my.host.com/sms\",\r\n \"smsMethod\": \"POST\",\r\n \"smsFallbackUrl\": \"http://my.host2.com/sms\",\r\n \"smsFallbackMethod\": \"POST\",\r\n \"phoneNumbers\": [\r\n \"+19892001234\"\r\n ],\r\n \"keywordActions\": {\r\n \"HI\": {\r\n \"campaignId\": \"e8861980-5165-11e9-b3b4-55cdbe9b37b5\"\r\n }\r\n }\r\n}"},"url":"{{url}}/v4/numberset/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"730","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"numberSetId\": \"85792550-5788-11eb-9a67-59113aa55d66\",\n \"name\": \"My number set\",\n \"forwardNumber\": \"\",\n \"callerIdName\": \"\",\n \"voiceUrl\": \"http://my.host.com/voice\",\n \"voiceMethod\": \"POST\",\n \"voiceFallbackUrl\": \"http://my.host2.com/voice\",\n \"voiceFallbackMethod\": \"POST\",\n \"hangupCallbackUrl\": \"http://my.host.com/hangup\",\n \"hangupCallbackMethod\": \"POST\",\n \"smsUrl\": \"http://my.host.com/sms\",\n \"smsMethod\": \"POST\",\n \"smsFallbackUrl\": \"http://my.host2.com/sms\",\n \"smsFallbackMethod\": \"POST\",\n \"heartbeatUrl\": \"http://my.host.com/heartbeat\",\n \"heartbeatMethod\": \"POST\",\n \"phoneNumbers\": [\n \"+19892001234\"\n ],\n \"keywordActions\": {\n \"HI\": {\n \"campaignId\": \"e8861980-5165-11e9-b3b4-55cdbe9b37b5\"\n }\n }\n }\n ]\n}"}],"_postman_id":"2630c0e9-bf8a-463f-b11d-b8810ca1058d"},{"name":"Add Number to Set","id":"4ed15c99-ed3d-454a-9a72-1d376da48e63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"numberSetId\": \"0e275620-52a2-11ea-810d-915e5688a0a1\",\r\n \"phoneNumbers\": [\r\n \"+19892001234\"\r\n ]\r\n}"},"url":"{{url}}/v4/numberset/addnumber/","description":"

Adds a list of phone numbers to a number set.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/numberset/:numberSetId/","description":"

Get a number set by id.

The Number Set ID to view

\n","type":"text/plain"},"type":"any","value":"0e275620-52a2-11ea-810d-915e5688a0a1","key":"numberSetId"}]}},"response":[{"id":"71efca96-2fe0-4ac9-a623-03cb61cd9772","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/numberset/:numberSetId/","host":["{{url}}"],"path":["v4","numberset",":numberSetId",""],"variable":[{"key":"numberSetId","value":"0e275620-52a2-11ea-810d-915e5688a0a1","description":"The Number Set ID to view"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"200","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"numberSetId\": \"0e275620-52a2-11ea-810d-915e5688a0a1\",\n \"name\": \"test2\",\n \"phoneNumbers\": [\n \"+19892001234\"\n ]\n }\n ]\n}"}],"_postman_id":"1bd7f3be-080d-4d70-81e8-2bbaf5a790cf"},{"name":"Edit Number Set","id":"b2b5fded-6d28-45bf-8985-426fca263e0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountSid\": \"1c2fbdd9-2a1c-f3a2-0cb1-cff2290024b\",\r\n \"forwardNumber\": \"\",\r\n \"callerIdName\": \"\",\r\n \"name\": \"My number set\",\r\n \"numberSetId\": \"995f3620-aa79-11ea-9401-4394f1d456e8\",\r\n \"voiceUrl\": \"http://my.host2.com/voice\",\r\n \"voiceMethod\": \"POST\",\r\n \"voiceFallbackUrl\": \"http://my.host2.com/voice2\",\r\n \"voiceFallbackMethod\": \"POST\",\r\n \"hangupCallbackUrl\": \"http://my.host2.com/hangup\",\r\n \"hangupCallbackMethod\": \"POST\",\r\n \"heartbeatUrl\": \"http://my.host2.com/heartbeat\",\r\n \"heartbeatMethod\": \"POST\",\r\n \"smsUrl\": \"http://my.host2.com/sms\",\r\n \"smsMethod\": \"POST\",\r\n \"smsFallbackUrl\": \"http://my.host2.com/sms2\",\r\n \"smsFallbackMethod\": \"POST\",\r\n \"phoneNumbers\": [\r\n \"+19999999999\"\r\n ],\r\n \"keywordActions\": {\r\n \"HI\": {\r\n \"campaignId\": \"a16ee280-a5af-11ea-a211-c7aac7851d9b\"\r\n }\r\n }\r\n}"},"url":"{{url}}/v4/numberset/:numberSetId/","description":"

Edits a number set. This does not allow for adjusting the numbers in the number set.

numberSetId

\n","type":"text/plain"},"type":"any","value":"numberSetId19","key":"numberSetId"}]}},"response":[],"_postman_id":"b2b5fded-6d28-45bf-8985-426fca263e0e"},{"name":"Delete Number Set","id":"466bfad2-4c13-43bf-b0f3-a67353e44a4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v4/numberset/:numberSetId/","description":"

Deletes a number set.

Number Set ID to delete

\n","type":"text/plain"},"type":"any","value":"0e275620-52a2-11ea-810d-915e5688a0a1","key":"numberSetId"}]}},"response":[{"id":"c06eda00-06fa-4691-a7fd-bbe8fcb789a1","name":"Sample Request","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v4/numberset/:numberSetId/","host":["{{url}}"],"path":["v4","numberset",":numberSetId",""],"variable":[{"key":"numberSetId","value":"0e275620-52a2-11ea-810d-915e5688a0a1","description":"Number Set ID to delete"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"186","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c307\",\n \"numberSetId\": \"0e275620-52a2-11ea-810d-915e5688a0a1\",\n \"name\": \"test2\",\n \"phoneNumbers\": []\n }\n ]\n}"}],"_postman_id":"466bfad2-4c13-43bf-b0f3-a67353e44a4c"},{"name":"Delete Numbers from Set","id":"29c75c61-6afc-4d1f-b082-28a44497c00e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v4/numberset/:numberSetId/:phoneNumbers/","description":"

Removes a list of phone numbers from a number set.

Number Set ID to remove number from

\n","type":"text/plain"},"type":"any","value":"0e275620-52a2-11ea-810d-915e5688a0a1","key":"numberSetId"},{"id":"1ff1bfff-9d3e-47cf-b89f-0cf531c989ad","description":{"content":"

the number to remove in E164 format

\n","type":"text/plain"},"type":"any","value":"+19892001234","key":"phoneNumbers"}]}},"response":[{"id":"611f0c80-fe47-4118-b50c-6c2eddffc966","name":"Sample Request","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v4/numberset/:numberSetId/:phoneNumbers/","host":["{{url}}"],"path":["v4","numberset",":numberSetId",":phoneNumbers",""],"variable":[{"key":"numberSetId","value":"0e275620-52a2-11ea-810d-915e5688a0a1","description":"Number Set ID to remove number from"},{"key":"phoneNumbers","value":"+19892001234","description":"the number to remove in E164 format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"186","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c307\",\n \"numberSetId\": \"0e275620-52a2-11ea-810d-915e5688a0a1\",\n \"name\": \"test2\",\n \"phoneNumbers\": []\n }\n ]\n}"}],"_postman_id":"29c75c61-6afc-4d1f-b082-28a44497c00e"}],"id":"c55a6a39-083f-4268-a6cd-f23ce05e5168","description":"

Number Sets are provided as a way to simplify management of phone numbers and api usage. Most of the management of numbers and number sets is best done through the UI.

In general numbers in a number set all share the same configurations. Adjustments that are made to a number set are propagated to all the numbers in the number set. Similarly any numbers that are added to a number set are updated to share the same configuration of all the numbers in the number set.

When being used by APIs, numbers in a number set are generally chosen at random to spread out the usage across the numbers in a number set. This allows for higher transactional volume since individual phone numbers are generally rate limited to approximately 1 qps and have max daily capacity limits.

When specifying keyword actions the format is the exact match key that will trigger the action. Within the body of the definition is the action that will be performed. Currently the only supported action is triggering a campaign.

{\n  \"accountSid\": \"6291c31a-e7e0-499f-b720-210e4aea3745\",\n  \"numberSetId\": \"be9c67a0-4d13-11ea-8a1f-6139612c1544\",\n  \"name\": \"My cool set\",\n  \"forwardNumber\": \"unused\",\n  \"callerIdName\": \"unused\",\n  \"voiceUrl\": \"www.mycompany.com/voice\",\n  \"voiceMethod\": \"POST\",\n  \"voiceFallbackUrl\": \"www.mycompany.com/voicefallback\",\n  \"voiceFallbackMethod\": \"GET\",\n  \"hangupCallbackUrl\": \"www.mycompany.com/hangup\",\n  \"hangupCallbackMethod\": \"POST\",\n  \"phoneNumbers\": [\"+12223334444\"],\n  \"smsUrl\": \"www.mycompany.com/sms\",\n  \"smsMethod\": \"POST\",\n  \"smsFallbackUrl\": \"www.mycompany.com/smsfallback\",\n  \"smsFallbackMethod\": \"GET\",\n  \"heartbeatUrl\": \"www.mycompany.com/heartbeat\",\n  \"heartbeatMethod\": \"POST\",\n  \"keywordActions\": {\n     \"myspecialkeyword\": {\n         \"campaignId\": \"d28165d0-1c6d-11ea-bd7b-6b2a3d952a97\"\n     }\n  }\n}\n\n

Fields:

name: Name of the number set
\n
forwardNumber: currently unused
\n
callerIdName: currently unused
\n
voiceUrl: Url to hit when an inbound voice call is received.
\n
phoneNumbers: Phone numbers associated with the number set. Only present when querying by numberSetId.
\n
voiceMethod: HTTP method to use in conjunction with the voiceUrl. Valid values GET and POST.
\n
voiceFallbackUrl: Url to use if voiceUrl fails.
\n
voiceFallbackMethod: HTTP method for voiceFallbackUrl.
\n
smsUrl: Url to hit when an inbound sms is received.
\n
smsMethod: HTTP method to use with smsUrl.
\n
smsFallbackUrl: Url to hit if smsUrl fails.
\n
smsFallbackMethod: HTTP method for smsFallbackUrl.
\n
heartbeatUrl: Url to hit for heartbeat messages.
\n
heartbeatMethod: HTTP method for heartbeatUrl.
\n
hangupCallbackUrl: Url to hit when a call is completed.
\n
hangupCallbackMethod: HTTP method for hangupCallbackUrl.
\n
keywordActions: A mapping of actions to take when a particular keyword is received. Currently this only supports starting a campaign.
\n

\n","_postman_id":"c55a6a39-083f-4268-a6cd-f23ce05e5168","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Saved Contact Queries","item":[{"name":"Get Saved Contact Queries","id":"e1814b1f-4aab-479c-a916-d3cd0cf8a6d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/query/contact","description":"

Returns back all of the saved contact queries in the system.

Replaces the saved query with the given id.

Id of the saved query

\n","type":"text/plain"},"type":"any","value":null,"key":"queryId"}]}},"response":[],"_postman_id":"d638d02c-dc8b-49aa-b88f-a371d55eedb5"}],"id":"36cd782e-869f-4a69-a80b-2429cd17911f","description":"

Saved queries are named queries that can be recalled at some later point in time.

For use with Contacts, these saved queries can be used for list management or to quickly find specific sets of contacts for testing.

\n","_postman_id":"36cd782e-869f-4a69-a80b-2429cd17911f","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Scripts","item":[{"name":"Get Scripts","id":"cd06a569-1bc1-4805-a421-648be06b0618","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/scriptadmin","description":"

Retrieves all scripts saved in the system. This is only available to users with the script-admin permission.

Retrieves a scripts by id. This is only available to users with the script-admin permission.

Saves a new script This is only available to users with the script-admin permission.

Updates an existing script This is only available to users with the script-admin permission.

id of the script

\n","type":"text/plain"},"type":"any","value":"","key":"scriptId"}]}},"response":[],"_postman_id":"f447c599-008a-4689-b3ae-f753f62b7dcd"},{"name":"Delete script","id":"67b8e9e2-c71c-4225-8dd8-6e4449fe2344","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{url}}/v4/scriptadmin/:scriptId","description":"

Deletes a scripts by id. This is only available to users with the script-admin permission.

Gets a script for execution with data populated for the given contact.

Executes a script and processes the responses from the script.

Scripts allow for setting a series of questions or prompts that can be processed by an agent.

There are two sets of endpoints for scripts. The first is intended to be used by an administrator to configure scripts, the second is intended to be used by an agent when talking with a contact.

A script must contain either an externalUrl and/or one or more questions. An externalUrl is a url that should be opened in a new window when the script is presented. Each question that passes the optional filter will be shown when the script is presented.

After a script is presented, it can be submitted. Any questions that are marked as being saved will be saved to the contact. Additionally the completion options will be evaluated based upon data contained on the contact and data included with the script submission to determine which script options should be presented to the agent upon submission.

{\n    \"accountSid\": \"6291c31a-e7e0-499f-b720-210e4aea3745\",\n    \"scriptId\": \"be9c67a0-4d13-11ea-8a1f-6139612c1544\",\n    \"name\": \"My First Script\",\n    \"externalURL\":null,\n    \"questions\": [\n        {\n            \"context\": \"Get the first name if unknown.\",\n            \"question\": \"What is your first name?\",\n            \"type\": \"string\",\n            \"variableName\": \"first_name\",\n            \"save\": true,\n            \"filters\": [\n                {\n                    \"negated\": true,\n                    \"variable\": \"first_name\",\n                    \"operation\": \"exists\"\n                }\n            ]\n        },\n        {\n            \"context\": \"Greet the customer and ask how to route\",\n            \"question\": \"Hi %%FIRST_NAME%%, what can I do to help you today?\"\n        },\n        {\n            \"question\": \"On a scale of 1 to 5 how would you rate this call?\",\n            \"type\": \"integer\",\n            \"variableName\": \"call_rating\",\n            \"save\": false,\n            \"minNumericValue\": 1,\n            \"maxNumericValue\": 10\n        }\n    ],\n    \"completionOptions\": [\n      {\n        \"filters\": [\n          \"variable\": \"call_rating\",\n          \"operation\": \"greater_than\",\n          \"value\": 3\n        ],\n        \"type\": \"transfer\",\n        \"details\": {\n          \"transferNumber\": \"+17145551234\"\n        }\n      },\n      {\n        \"type\": \"campaign\",\n        \"details\": {\n          \"campaignId\": \"1234c31a-e7e0-499f-b720-210e4aea3745\"\n        }\n      }, \n      {\n        \"filters\": [\n          \"negated\": true\n          \"variable\": \"call_rating\",\n          \"operation\": \"greater_than\",\n          \"value\": 3\n        ],\n        \"type\": \"script\",\n        \"details\": {\n          \"scriptId\": \"1234c31a-e7e0-499f-b720-210e4aea3745\"\n        }\n      }\n    ]\n}\n\n

Fields:

accountSid: The account associated with this script.
\n
scriptId: Unique id for a script.
\n
name: Display name for the script.
\n
externalUrl: URL that will be opened when a script is being evaluated.
\n
questions: The list of questions that should be asked.
\n
completionOptions: Optional set of actions that an agent can choose from once the script has been evaluated.
\n
callbackId: Reference to a callback to be invoked when the script has completed.
\n

Fields within a question:

context: Optional context for the question. Intended not to be read to the contact.
\n
question: Script to be read to the contact.
\n
type: Data type of the response for validation. Valid types: string, integer, decimal, boolean.
\n
variableName: Name of the variable the the response will be stored in.
\n
save: Boolean value to determine if the response should be stored onto the contact.
\n
options: List of option values suitable as keys.
\n
displayOptions: List of display values for items in the options list. Must be the same size as options.
\n
minNumericValue: Minimum valid value for a numeric value
\n
maxNumericValue: Maximum valid value for a numeric value
\n
filters: List of statements that must be true for the question to be shown. If no filters exist for a question it will be shown.
\n

Note that script validation options are intended for frontend validation and are not validated on script submission.

Fields within a completion option:

filters: List of statements that must be true for the option to be available. If no filters exist for a completion option it will always be presented.
\n
type: Action type that can be performed. Valid values: transfer, campaign, hangup, script.
\n
details: Key/value pairs that are associated with the completion option type. transfer requires a transferNumber. campaign requires a campaignId. hangup has no required options. script requires a scriptId.
\n

Statements for filters have the following fields:

negated: Whether the statement evaluation should be flipped. Default false.
\n
variable: Name of the variable to be checked
\n
operation: Operation to be performed. Valid values: equals, equals_one_of, contains, contains_one_of, begins_with, ends_with, less_than, greater_than, exists.
\n
value: Value to check against. Required for everything other than exists.
\n

\n","_postman_id":"fd7769c9-f7fd-4154-88b4-3e04d6aaa874","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Shortcodes","item":[{"name":"Edit Shortcode","id":"e36b58dd-2825-4cd8-a882-0bf6714e16fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"friendlyName\": \"My dedicated short code\",\r\n \"smsMethod\": \"GET\",\r\n \"smsUrl\": \"http://my.host.com/sms\",\r\n \"smsFallbackMethod\": \"POST\",\r\n \"smsFallbackUrl\": \"http://my.host2.com/sms\"\r\n}"},"url":"{{url}}/v4/shortcode/:phoneNumber/","description":"

Edits editable fields on a shared short code.

Editable fields:

friendlyName
smsUrl and smsMethod
smsFallbackUrl and smsFallbackMethod

phoneNumber

\n","type":"text/plain"},"type":"any","value":"12345","key":"phoneNumber"}]}},"response":[{"id":"e59a0351-a668-4bba-abde-1ea7e3194b24","name":"Sample Request","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"friendlyName\": \"My dedicated short code\",\r\n \"smsMethod\": \"GET\",\r\n \"smsUrl\": \"http://my.host.com/sms\",\r\n \"smsFallbackMethod\": \"POST\",\r\n \"smsFallbackUrl\": \"http://my.host2.com/sms\"\r\n}"},"url":{"raw":"{{url}}/v4/shortcode/:phoneNumber/","host":["{{url}}"],"path":["v4","shortcode",":phoneNumber",""],"variable":[{"key":"phoneNumber","value":"12345","description":"phoneNumber"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"301","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"friendlyName\": \"My dedicated short code\",\n \"phoneNumber\": \"12345\",\n \"smsUrl\": \"http://my.host.com/sms\",\n \"smsMethod\": \"GET\",\n \"smsFallbackUrl\": \"http://my.host2.com/sms\",\n \"smsFallbackMethod\": \"POST\",\n \"numberType\": 4\n }\n ]\n}"}],"_postman_id":"e36b58dd-2825-4cd8-a882-0bf6714e16fe"}],"id":"8d557b1d-36e4-4a8f-8dca-3fa1a18c18dc","description":"

Shortcode Controller

\n","_postman_id":"8d557b1d-36e4-4a8f-8dca-3fa1a18c18dc","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"SMS","item":[{"name":"Send SMS","id":"57796607-3624-491a-8e19-4f3967e2d60d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"from\": \"{{fromnumber}}\",\n \"text\": \"Hello World!!\",\n \"to\": \"{{tonumber}}\",\n \"deliveryStatusEnabled\": \"true\",\n \"messageStatusCallback\": \"{{callbackurl}}\",\n \"metadata\": {\n \"leadId\": \"myLeadId\",\n \"customId\": \"myCustomId\"\n }\n}"},"url":"{{url}}/v4/sms/","description":"

Sends an SMS message. This endpoint supports multiple different ways to send an SMS message with many fields that are mutually exclusive.

For the source phone number either the from field or the numberSetId field must be provided. If the numberSetId field is used, a number will be chosen from the number set at random.

For the message body either the text field or the smsTemplateId field must be provided. If using a template, the extData field will be used for any template replacements. If a contact is specified, the provided extData will be used preferentially over the data in the contact when expanding the template.

If sending an MMS message, the mediaUrl property must be provided. In this case the body fields are optional.

Setting the deliveryStatusEnabled flag (default false) will result in a DLR callback.

Setting the messageStatusCallback will result in a POST of json data once the message is sent.

The metadata parameter will allow for passing key/value pairs. If provided, these values will be available on the sms log record as well as any callbacks that are configured for sms.

We recommend using number sets, contacts, and sms templates for API usage since these will result in fewer changes over time.

Endpoints for sending SMS messages to a user.

\n","_postman_id":"18c353bf-61f6-44d1-be84-f6fe30e5dc59","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"SMS Templates","item":[{"name":"Get Templates","id":"eafbdd7e-b543-4438-8f81-4876f0f7f864","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/smstemplate/","description":"

Retrieves all sms templates on the account.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"templateText\": \"Hello %%VARIABLENAME%% world!\",\r\n \"templateTitle\": \"Hello world.\",\r\n \"templateMediaUrl\": \"https://www.example.com/image.png\"\r\n}"},"url":"{{url}}/v4/smstemplate/","description":"

Adds a new sms template. Each template must have at least one of templateText and templateMediaUrl.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"templateText\": \"Hello %%VARIABLENAME%% world. Now with updated template text\",\r\n \"templateTitle\": \"Hello world.\"\r\n}"},"url":"{{url}}/v4/smstemplate/:templateId","description":"

editTemplate

template id

\n","type":"text/plain"},"type":"any","value":"3539d410-5f65-11eb-a080-51e25f7d5918","key":"templateId"}]}},"response":[{"id":"5255c7d1-4796-4da9-bc04-70831e86b1c4","name":"Sample Request","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"templateText\": \"Hello %%VARIABLENAME%% world. Now with updated template text\",\r\n \"templateTitle\": \"Hello world.\"\r\n}"},"url":{"raw":"{{url}}/v4/smstemplate/:templateId","host":["{{url}}"],"path":["v4","smstemplate",":templateId"],"variable":[{"key":"templateId","value":"3539d410-5f65-11eb-a080-51e25f7d5918","description":"template id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"316","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"templateId\": \"3539d410-5f65-11eb-a080-51e25f7d5918\",\n \"templateText\": \"Hello %%VARIABLENAME%% world. Now with updated template text\",\n \"templateTitle\": \"Hello world.\",\n \"templateMediaUrl\": \"https://www.example.com/image.png\"\n }\n ]\n}"}],"_postman_id":"a60d27d3-dce8-4dfb-9a79-24355f5d6dfe"},{"name":"Get Template","id":"6f814658-fb97-40a0-adb9-2d256b14c08d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/smstemplate/:templateId/","description":"

Get and sms template by id.

template id to get

\n","type":"text/plain"},"type":"any","value":"3539d410-5f65-11eb-a080-51e25f7d5918","key":"templateId"}]}},"response":[{"id":"2cad0ed0-704c-4d8c-bf02-a41b9eda2799","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/smstemplate/:templateId/","host":["{{url}}"],"path":["v4","smstemplate",":templateId",""],"variable":[{"key":"templateId","value":"3539d410-5f65-11eb-a080-51e25f7d5918","description":"template id to get"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"316","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"templateId\": \"3539d410-5f65-11eb-a080-51e25f7d5918\",\n \"templateText\": \"Hello %%VARIABLENAME%% world. Now with updated template text\",\n \"templateTitle\": \"Hello world.\",\n \"templateMediaUrl\": \"https://www.example.com/image.png\"\n }\n ]\n}"}],"_postman_id":"6f814658-fb97-40a0-adb9-2d256b14c08d"},{"name":"Archive Template","id":"0c484cdf-d505-45e7-972a-132fdea07ae5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v4/smstemplate/:templateId","description":"

Archives an sms template. Like all other archive operations, there is no way to search for archived data.

template id to archive

\n","type":"text/plain"},"type":"any","value":"3539d410-5f65-11eb-a080-51e25f7d5918","key":"templateId"}]}},"response":[{"id":"c1a31770-7d74-4388-87bd-10ba7454c15d","name":"Sample Request","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v4/smstemplate/:templateId","host":["{{url}}"],"path":["v4","smstemplate",":templateId"],"variable":[{"key":"templateId","value":"3539d410-5f65-11eb-a080-51e25f7d5918","description":"template id to archive"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"316","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"templateId\": \"3539d410-5f65-11eb-a080-51e25f7d5918\",\n \"templateText\": \"Hello %%VARIABLENAME%% world. Now with updated template text\",\n \"templateTitle\": \"Hello world.\",\n \"templateMediaUrl\": \"https://www.example.com/image.png\"\n }\n ]\n}"}],"_postman_id":"0c484cdf-d505-45e7-972a-132fdea07ae5"},{"name":"Unarchive Template","id":"b4f4f604-6858-433a-a2d4-2c2664a7b807","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v4/smstemplate/:templateId/unarchive","description":"

Restores a previously archived template.

templateId to Unarchive

\n","type":"text/plain"},"type":"any","value":"3539d410-5f65-11eb-a080-51e25f7d5918","key":"templateId"}]}},"response":[{"id":"54ee769a-68e9-4c3f-b655-19f9b4f9f586","name":"Sample Request","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v4/smstemplate/:templateId/unarchive","host":["{{url}}"],"path":["v4","smstemplate",":templateId","unarchive"],"variable":[{"key":"templateId","value":"3539d410-5f65-11eb-a080-51e25f7d5918","description":"template Id to Unarchive"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"316","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"templateId\": \"3539d410-5f65-11eb-a080-51e25f7d5918\",\n \"templateText\": \"Hello %%VARIABLENAME%% world. Now with updated template text\",\n \"templateTitle\": \"Hello world.\",\n \"templateMediaUrl\": \"https://www.example.com/image.png\"\n }\n ]\n}"}],"_postman_id":"b4f4f604-6858-433a-a2d4-2c2664a7b807"}],"id":"a98499b5-3dca-4a58-9f64-bdbbe0ebffda","description":"

Sms templates are a way to preconfigure a message and optionally have variables in the template replaced with provided variables.

The content of a template may look like:

This is your first templatized text from Ytel with no variables.\n

Hello %%VARIABLENAME%% world!\n

Hello %%VARIABLENAME|fallback text%% world!\n

The naming convention for variables in templates is all UPPERCASE between two sets of %%.

When the template is evaluated it will look for a variable named variablename. Apis that support sms templates will also take both a contact id and additional extData. If both are provided, the provided extData is examined first with a fallback to the contact's extData.

If a | character is present immediately following the variable, the text following it up until the next set of %% characters will be used as fallback text in the event that the variable is not found.

Example data structure:

{\n  \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c307\",\n  \"templateId\": \"8ebb25d0-bde9-11e9-a801-4bd9a183fd0d\",\n  \"templateText\": \"Hello %%VARIABLENAME%% world!\",\n  \"templateTitle\": \"Hello world\",\n  \"templateMediaUrl\": \"https://www.example.com/image.png\",\n  \"lastUsed\": \"2020-03-19 11:45:45\"\n}\n

accountSid: Account id
templateId: Generated unique id
templateText: Text of the template.
templateTitle: Friendly name for the template, not visible to the end consumer.
templateMediaUrl: Url used for an MMS message. This should be a link to an image file.
lastUsed: Last timestamp that a template was used by a campaign

\n","_postman_id":"a98499b5-3dca-4a58-9f64-bdbbe0ebffda","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Statistics","item":[{"name":"Aggregate Statistics","id":"b60004e3-8991-4ec3-b12a-4a753df45e28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/statistics/aggregate?startTimeMs=&endTimeMs=&minutesAggregate=","description":"

Returns back some basic aggregate statistics for events that have happened between the provided start and end times. If these are not provided it will default to the last hour with data aggregated into buckets by minute.

Each bucket of results will contain the following:
timeMs: Beginning of the time period for the bucket in epoch millis

callsDialed: Number of phone calls that were initiated

outboundCallsStarted: Number of outbound calls that connected

inboundCallsStarted: Number of inbound calls that connected

callsCompleted: Number of calls that finished

inboundSms: Number of inbound sms messages received

outboundSms: Number of outbound sms messages sent

Earliest time for data in epoch milliseconds

\n","type":"text/plain"},"key":"startTimeMs","value":""},{"description":{"content":"

Last time for data in epoch milliseconds

\n","type":"text/plain"},"key":"endTimeMs","value":""},{"description":{"content":"

Number of minutes to aggregate together

\n","type":"text/plain"},"key":"minutesAggregate","value":""}],"variable":[]}},"response":[],"_postman_id":"b60004e3-8991-4ec3-b12a-4a753df45e28"},{"name":"Hourly statistics","id":"762066d5-226d-4a90-8a81-6c40b02bd8d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/statistics/numbers/hourly?startTimeMs=&endTimeMs=&grouping=&phoneNumber=&campaignId=","description":"

This endpoint will return hourly statistics of usage grouped either by phone number or workflow with optional filtering to only see the results for a single phone number or workflow.

Returned values:
campaignId: Associated workflow if grouping by workflow.

number: Phone number if grouping by phone number

hourMs: Start of the aggregated hour in epoch milli.

sms: Data object containing information about sms traffic.

sms.inbound: Number of sms inbound messages.

sms.outbound: Number of sms outbound messages.

call: Data object containing information about call data. These are separated by call type.

call.inbound: Number of inbound calls completed during this period of time.

call.outbound: Number of outbound calls completed during this period of time.

call.inboundDurationSeconds: Number of seconds of inbound calls completed during this period of time.

call.outboundDurationSeconds: Number of seconds of outbound calls completed during this period of time.

Earliest time for data in epoch milliseconds

\n","type":"text/plain"},"key":"startTimeMs","value":""},{"description":{"content":"

Last time for data in epoch milliseconds

\n","type":"text/plain"},"key":"endTimeMs","value":""},{"description":{"content":"

How aggregates should be grouped. Valid values: phoneNumber or campaignId

\n","type":"text/plain"},"key":"grouping","value":""},{"description":{"content":"

Filter to only show results for a single phone number

\n","type":"text/plain"},"key":"phoneNumber","value":""},{"description":{"content":"

Filter to only show results for a single workflow

\n","type":"text/plain"},"key":"campaignId","value":""}],"variable":[]}},"response":[],"_postman_id":"762066d5-226d-4a90-8a81-6c40b02bd8d3"},{"name":"Communication aggregate statistics","id":"8ef4bb9d-4f5a-4b01-9cf2-dfb48fcfd0e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/statistics/communications/aggregate?startTimeMs=&endTimeMs=&grouping=&aggregatePeriod=&minSpend=&maxSpend=&minDuration=&maxDuration=&phoneNumbers=&webrtcClientIds=&numberSetId=&sortByHourMs","description":"

Returns aggregate statistics for the given period of time aggregated by the aggregation period.

Returned values:
hourMs: Start of the time period in epoch millis.

number: Phone number for the aggregation period if aggregating by phone number.

webrtcUserId: Webrtc user's client id if aggregating by webrtc users.

numberSetId: Number set id if aggregating by number sets.

sms: Data about sms messages during the aggregation period.

sms.inbound: Number of inbound sms messages.

sms.outbound: Number of outbound sms messages.

sms.inboundCost: Cost of all inbound sms messages.

sms.outboundCost: Cost of all outbound sms messages.

sms.minMessageCount: Smallest size of a single billable sms message.

sms.maxMessageCount: Largest size of a single billable sms message.

sms.optOuts: Number of sms opt outs received.

call: Call data about calls completed during the aggregation period grouped by call type.

call.inboundCount: Number of inbound calls completed.

call.outboundCount: Number of outbound calls completed.

call.inboundCallDuration: Duration of all inbound calls in seconds.

call.outboundCallDuration: Duration of all outbound calls in seconds.

call.minInboundDuration: Minimum duration of inbound calls in seconds.

call.maxInboundDuration: Maximum duration of inbound calls in seconds.

call.minOutboundDuration: Minimum duration of outbound calls in seconds.

call.maxOutboundDuration: Maximum duration of outbound calls in seconds.

call.inboundCost: Total cost of all inbound calls.

call.outboundCost: Total cost of all outbound calls.

Earliest time for data in epoch milliseconds

\n","type":"text/plain"},"key":"startTimeMs","value":""},{"description":{"content":"

Last time for data in epoch milliseconds

\n","type":"text/plain"},"key":"endTimeMs","value":""},{"description":{"content":"

How aggregates should be grouped. Valid values: phoneNumber, webrtcUser, numberSet, none. Default: none

\n","type":"text/plain"},"key":"grouping","value":""},{"description":{"content":"

Units of time that aggregation is done for. Valid values: hours, days, weeks. Default: hours

\n","type":"text/plain"},"key":"aggregatePeriod","value":""},{"description":{"content":"

Filter for minimum charged . Default: none (optional)

\n","type":"text/plain"},"key":"minSpend","value":""},{"description":{"content":"

Filter for maximum charged. Default: none (optional)

\n","type":"text/plain"},"key":"maxSpend","value":""},{"description":{"content":"

Filter for minimum duration of calls. Default: none (optional)

\n","type":"text/plain"},"key":"minDuration","value":""},{"description":{"content":"

Filter for maximum duration of calls. Default: none (optional)

\n","type":"text/plain"},"key":"maxDuration","value":""},{"description":{"content":"

Filter to only show results for the specified phone numbers. Comma separated list. Default: none (optional)

\n","type":"text/plain"},"key":"phoneNumbers","value":""},{"description":{"content":"

Filter to only show results for the specified webrtc users. Comma separated list. Default: none (optional)

\n","type":"text/plain"},"key":"webrtcClientIds","value":""},{"description":{"content":"

Filter to only show results for a single number set. Default: none (optional)

\n","type":"text/plain"},"key":"numberSetId","value":""},{"description":{"content":"

Sort direction based on startTimeMs, can be asc or desc

\n","type":"text/plain"},"key":"sortByHourMs","value":""}],"variable":[]}},"response":[],"_postman_id":"8ef4bb9d-4f5a-4b01-9cf2-dfb48fcfd0e9"}],"id":"d9a32a00-3774-4068-8654-49c60907be26","_postman_id":"d9a32a00-3774-4068-8654-49c60907be26","description":"","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Timezones","item":[{"name":"Get Timezones","id":"19b8bcdc-adf3-4fea-bbce-6394de4377e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/timezone/","description":"

Get all timezones.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","timezone",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"06dc2b7b-ea2c-4780-bdc1-8a53c48de916","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":"{{url}}/v4/timezone/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"904","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 11,\n \"page\": 1,\n \"payload\": [\n {\n \"timezoneId\": -20,\n \"name\": \"EST/EDT\",\n \"systemName\": \"EST5EDT\",\n \"dst\": 1,\n \"offset\": -5\n },\n {\n \"timezoneId\": -28,\n \"name\": \"MST/MDT\",\n \"systemName\": \"MST7MDT\",\n \"dst\": 1,\n \"offset\": -7\n },\n {\n \"timezoneId\": -32,\n \"name\": \"PST/PDT\",\n \"systemName\": \"PST8PDT\",\n \"dst\": 1,\n \"offset\": -8\n },\n {\n \"timezoneId\": 0,\n \"name\": \"UTC\",\n \"systemName\": \"UTC\",\n \"dst\": 0,\n \"offset\": 0\n },\n {\n \"timezoneId\": -33,\n \"name\": \"PST\",\n \"systemName\": \"Etc/GMT-8\",\n \"dst\": 0,\n \"offset\": -8\n },\n {\n \"timezoneId\": -29,\n \"name\": \"MST\",\n \"systemName\": \"US/Arizona\",\n \"dst\": 0,\n \"offset\": -7\n },\n {\n \"timezoneId\": -128,\n \"name\": \"Unknown\",\n \"systemName\": null,\n \"dst\": 0,\n \"offset\": 0\n },\n {\n \"timezoneId\": -24,\n \"name\": \"CST/CDT\",\n \"systemName\": \"CST6CDT\",\n \"dst\": 1,\n \"offset\": -6\n },\n {\n \"timezoneId\": -25,\n \"name\": \"CST\",\n \"systemName\": \"Etc/GMT-6\",\n \"dst\": 0,\n \"offset\": -6\n },\n {\n \"timezoneId\": -130,\n \"name\": \"ANY\",\n \"systemName\": null,\n \"dst\": 0,\n \"offset\": 0\n },\n {\n \"timezoneId\": -21,\n \"name\": \"EST\",\n \"systemName\": \"Jamaica\",\n \"dst\": 0,\n \"offset\": -5\n }\n ]\n}"}],"_postman_id":"19b8bcdc-adf3-4fea-bbce-6394de4377e2"},{"name":"Get Timezone","id":"f645da01-6dd0-4072-bd06-55a514cf25ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/timezone/:timezoneId/","description":"

Get one timezone.

timezoneId

\n","type":"text/plain"},"type":"any","value":"-28","key":"timezoneId"}]}},"response":[{"id":"68da0851-0289-48b8-8845-c3499413c3d0","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/timezone/:timezoneId/","host":["{{url}}"],"path":["v4","timezone",":timezoneId",""],"variable":[{"key":"timezoneId","value":"-28","description":"timezoneId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"127","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"timezoneId\": -28,\n \"name\": \"MST/MDT\",\n \"systemName\": \"MST7MDT\",\n \"dst\": 1,\n \"offset\": -7\n }\n ]\n}"}],"_postman_id":"f645da01-6dd0-4072-bd06-55a514cf25ae"}],"id":"5a2c0d7c-1a22-4e3c-bf5d-483f560e1ec1","description":"

Timezones are in many places referred to by their internal id. These endpoints allow for looking up the static set of timezone data used by Ytel.

Example:

{\n  \"timezoneId\": -20,\n  \"name\": \"EST/EDT\",\n  \"systemName\": \"EST5EDT\",\n  \"dst\": 1,\n  \"offset\": -5.0\n}\n

timezoneId: Id of the timezone
name: Name of the timezone
systemName: Alternative name for the timezone
dst: 1 for observes daylight savings time, 0 for not observes daylight savings time
offset: Number of hours off UTC this timezone is.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"da7d8b99-69b3-4085-a172-8f73cfd2e5e9"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a67b457c-8933-473f-86c4-e5f022116456"}}],"_postman_id":"5a2c0d7c-1a22-4e3c-bf5d-483f560e1ec1","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"User Management","item":[{"name":"Get Users","id":"b2dbf111-280c-41fa-a93b-b04cf49deb72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"https://api.ytel.com/ams/v3/users/","description":"

Returns data about all the users on an account.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"https://api.ytel.com/ams/v3/users/:clientId","description":"

Returns data about all the specified user.

UUID that is the user's id

\n","type":"text/plain"},"type":"any","value":null,"key":"clientId"}]}},"response":[],"_postman_id":"4b62b5cf-68f3-419b-849e-9183b7ff60ef"},{"name":"Get User by Username","id":"91065b8f-326f-4a26-b9ac-33c4e0bce43e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"https://api.ytel.com/ams/v3/users/usernames/:username","description":"

Returns data about all the specified user.

Username of a user

\n","type":"text/plain"},"type":"any","value":null,"key":"username"}]}},"response":[],"_postman_id":"91065b8f-326f-4a26-b9ac-33c4e0bce43e"},{"name":"Create User","id":"692c552d-e428-4c66-a029-4d9dbcb07ea7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"belongAcctId\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"clientId\": null,\n \"firstName\": \"Annie\",\n \"lastName\": \"Apple\",\n \"password\": \"&OneOneTwoTwo222\",\n \"phone\": \"+1234567899\",\n \"roles\": [\n \"webrtc-agent\"\n ],\n \"status\": \"active\",\n \"username\": \"example@dev.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/users","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"protocol":"https","path":["ams","v3","users"],"host":["api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"692c552d-e428-4c66-a029-4d9dbcb07ea7"},{"name":"Edit User","id":"e8902746-1ccb-423b-934f-ffc87e338202","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Annie\",\n \"lastName\": \"Apple\",\n \"phone\": \"+1234567899\",\n \"roles\": [\n \"webrtc-agent\"\n ],\n \"username\": \"example@dev.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/users/:clientId","description":"

Modifies basic details about a user. Any fields that are provided will replace existing data about the user and any field not passed will retain the old value. The roles field is the only exception and must be sent every time with the set of roles that the user should have.

The following properties may not be modified using this endpoint:

password
status

UUID for the user's clientId

\n","type":"text/plain"},"type":"any","value":null,"key":"clientId"}]}},"response":[],"_postman_id":"e8902746-1ccb-423b-934f-ffc87e338202"},{"name":"Edit User by Username","id":"3c7beb4e-132c-4e19-aadb-73e51406256c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

The following properties may not be modified using this endpoint:

password
status

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"oldPassword\": \"badOldPassword\",\n \"newPassword\": \"newGoodPassword\",\n \"pincode\": 1234\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/users/password/update","description":"

Updates a user's password from oldPassword to newPassword. This will fail if the oldPassword does not match the user's current password.

If 2FA is enabled for the user the pincode is required.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/users/status/:clientId","description":"

Changes a user's active state. Valid values: active and inactive.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"https://api.ytel.com/ams/v3/users/:clientId","description":"

Deletes a user.

UUID for the user's clientId

\n","type":"text/plain"},"type":"any","value":null,"key":"clientId"}]}},"response":[],"_postman_id":"976aea4f-7ea1-4939-bdc2-0949341eaecf"},{"name":"Delete User by Username","id":"ececfb19-5d6b-440c-bbe6-eedbc918b39f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"https://api.ytel.com/ams/v3/users/usernames/:username","description":"

Deletes a user.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"available\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/users/webtrc/list","description":"

Get's the current status of all webphone users.

Values returned:

key.accountSid: accountId of the account
key.clientId: userId of the user
login: Time of login
status: User's status
callsid: UUID for the call that the user is in (if any).
confId: UUID for the conference that the user is in (if any).
lastAction: Time of the last action performed by the user.
username: Username of the webrtc user
number: Number assigned to the user
numberSetId: Numberset id that the user has been assigned.
serverIds: Ids of the server(s) that the user is connected to.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"available\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/users/webtrc/:clientId","description":"

Get's the current status of a webphone user.

UUID of the user

\n","type":"text/plain"},"type":"any","value":null,"key":"clientId"}]}},"response":[],"_postman_id":"b2814e5c-e665-4201-a45f-3f9fcbcd62a3"},{"name":"Change User Webphone status","id":"ea764d83-c739-4952-9677-381ba3bc733a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"available\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/users/webtrc/:clientId","description":"

Changes a user's webphone status. Valid status values are available and unavailable.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/users/setup2fa","description":"

Sets the user to require two factor authentication.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"pincode\": 1234,\n \"password\": \"goodPassword\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/users/confirm2fa","description":"

Checks to see if two factor authentication is a match.

Generated using the v4 Authentication endpoint.

Removes 2fa authentication from an account. Requires that the pincode and password match.

Generated using the v4 Authentication endpoint.

Removes 2fa authentication from another user. The password needs to match the clearing user's password and the pincode must be supplied if the clearing user has 2fa enabled.

Retrieves a list of all known roles that can be assigned to a user and the privileges that the role allows.

Data from this endpoint very rarely changes and can safely be cached nearly indefinitely.

    {\n        \"name\": \"contact-admin\",\n        \"displayName\": \"Contacts\",\n        \"privileges\": [\n            \"contact-update\",\n            \"contact-delete\",\n            \"contact-read-all\",\n            \"contact-read\"\n        ]\n    }\n\n

Fields:

name: Internal name of the role
displayName: Displayable name of the role
privileges: List of privileges that the role has been granted.

Retrieves a list of all known roles that can be assigned to a user and the privileges that the role allows. The user authentication tokens will include the privileges as a bitmask. Offsets from 0-31 will be in the first number, offsets 32-63 will be in the second, etc.

Data from this endpoint very rarely changes and can safely be cached nearly indefinitely.

    {\n        \"name\": \"acct-create\",\n        \"displayName\": \"Account Create\",\n        \"binaryPos\": 7,\n        \"symbolicNumber\": 128\n    }\n\n

Fields:

name: Internal name for the privilege
displayName: Name for the privilege that can be displayed in a UI
binaryPos: Bit offset for the privilege
symbolicNumber: Computed value from binaryPos. Formula is 1 << (_binaryPos_2).

User management apis allow for the management of users that are allowed to login to Ytel systems.

Account and User management endpoints require a token generated by the Authentication endpoint. A long lived token generated in the UI will not work with these endpoints.

Users are uniquely identified by a clientId, which in many other systems would be the user id.

Fields present on a user:

clientId: Unique identifier for a user
username: Login name for a user. This must be an email address and cannot be changed.
password: User password. This value is never returned by any api and stored in an encrypted state.
roles: Set of roles that a user has been granted. These dictate which api permissions a user is allowed to access.
userStatus: Active status of the user. Valid values: active and inactive.
belongAcctId: Account that this user belongs to.
parentAcctId: Parent account that is responsible for this account. If this user does not belong to a subaccount it will be the same as belongAcctId.
firstName: First name of a user
lastName: Last name of a user
displayName: Display name for the user.
emailAddress: Email address of a user for notifications. This will typically be the same as username, but may be changed.
phone: Phone number of the user.
source: Source for where the user came from.
avatar: Image for the user in the UI.
webrtcNumber: Webphone number assigned to this user.
ucaasExtension: extension for ucaas.
ucaasCode: code for ucaas.
twoFactorEnabled: Whether two factor authentication is enabled for this user.

\n","_postman_id":"d57865bd-0a38-45c2-b121-1af89f7bece7","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Webhooks","item":[{"name":"Get All Webhook Common Configurations","id":"dd193f20-e53a-4dbe-ae0c-b7268774711e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/callback/authentication/","description":"

Retrieves all common configuration data.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Example config\",\n \"description\": \"Configuration for talking to example server\",\n \"headers\": {\n \"Content-type\": \"application/json\",\n \"MyCustomHeader\": \"my custom header value\"\n },\n \"authHeaders\": {\n \"Authentication\": \"Bearer %ACCESS_TOKEN%\",\n \"Username\": \"server username\",\n \"Password\": \"server password\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/callback/authentication/","description":"

Creates a new common configuration

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","callback","authentication",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"469872b9-cfc9-4afb-b74e-3e51ae8c8cfb","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Example config\",\n \"description\": \"Configuration for talking to example server\",\n \"headers\": {\n \"Content-type\": \"application/json\",\n \"MyCustomHeader\": \"my custom header value\"\n },\n \"authHeaders\": {\n \"Authentication\": \"Bearer %%ACCESS_TOKEN%%\",\n \"Username\": \"server username\",\n \"Password\": \"server password\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/callback/authentication/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"596","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"id\": \"b41770b0-5503-11eb-9a67-59113aa55d66\",\n \"name\": \"Example config\",\n \"description\": \"Configuration for talking to example server\",\n \"headers\": {\n \"Content-type\": \"application/json\",\n \"MyCustomHeader\": \"my custom header value\"\n },\n \"authHeaders\": {\n \"Username\": \"cKBtqNSKlIs1pXKL4nm57bsKgzp8/T0MNEru5r7OLBlTq/9e3pmrpd3gLVos+Bec\",\n \"Authentication\": \"mIsiMqzN8AczEy/Ci7jo8xHksC5vtN+q+AdeSwvPs6W5IDPhu7z0L3KZLU8Um5zRH9Ub86aS/q/1TV5KG5ayDQ==\",\n \"Password\": \"tF/02yi79HH9z4FTb3KQ2bwmBfuzK1nHaO+wlkbFz9F889rN0SFZQW7BSmKUIzL5\"\n }\n }\n ]\n}"}],"_postman_id":"df2f9e3d-1eec-4483-a574-1c136b72ee4a"},{"name":"Edit Webhook Common Configuration","id":"46e007d0-019c-4496-a129-a2fcaa2cc75d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

Edits a common configuration

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","callback","authentication",":callbackAuthId",""],"host":["{{url}}"],"query":[],"variable":[{"id":"7ec8e75c-3023-4e77-a9bf-428243a6dcad","type":"any","value":"b41770b0-5503-11eb-9a67-59113aa55d66","key":"callbackAuthId"}]}},"response":[{"id":"0922b5e8-8798-45dc-ad6e-08dbafa3d7ef","name":"Sample Request","originalRequest":{"method":"PUT","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Example config\",\n \"description\": \"Configuration for talking to example server\",\n \"headers\": {\n \"Content-type\": \"application/json\",\n \"MyCustomHeader\": \"my custom header value\"\n },\n \"authHeaders\": {\n \"Authentication\": \"Bearer %%ACCESS_TOKEN%%\",\n \"Username\": \"server username\",\n \"Password\": \"server password\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v4/callback/authentication/:callbackAuthId/","host":["{{url}}"],"path":["v4","callback","authentication",":callbackAuthId",""],"variable":[{"key":"callbackAuthId","value":"b41770b0-5503-11eb-9a67-59113aa55d66"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"596","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"id\": \"b41770b0-5503-11eb-9a67-59113aa55d66\",\n \"name\": \"Example config\",\n \"description\": \"Configuration for talking to example server\",\n \"headers\": {\n \"Content-type\": \"application/json\",\n \"MyCustomHeader\": \"my custom header value\"\n },\n \"authHeaders\": {\n \"Username\": \"da/RnR8AHMOhJQ/zJdmKGzpDHDb6cczk/AWhd7j/p7q6HcdWspPEEh3+jNJ3uo9s\",\n \"Authentication\": \"WPdfm62AVZHioHru39380eJNOoWbH86ZqV6Uv/Q0LlvIHJQt1n4YSvGj0QuSLYiQUNW6ZglLRoirDWtZys9PRQ==\",\n \"Password\": \"fut4AWqUdggTxhVQGyj2eZtfpcG6+gQCDFqYQVK7F+ceFvZx5Tk9kX4OdCDJtwbR\"\n }\n }\n ]\n}"}],"_postman_id":"46e007d0-019c-4496-a129-a2fcaa2cc75d"},{"name":"Get Webhook Common Configuration by Id","id":"90384871-9b9c-45b0-9815-2c5fae8f0784","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/callback/authentication/:callbackAuthId/","description":"

Edits a common configuration

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","callback","authentication",":callbackAuthId",""],"host":["{{url}}"],"query":[],"variable":[{"id":"257d0498-d6f7-4f3a-a6fd-b1597c6002ca","type":"any","value":"b41770b0-5503-11eb-9a67-59113aa55d66","key":"callbackAuthId"}]}},"response":[{"id":"2d39328e-b5cb-403b-bf92-cb0af150a016","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/callback/authentication/:callbackAuthId/","host":["{{url}}"],"path":["v4","callback","authentication",":callbackAuthId",""],"variable":[{"key":"callbackAuthId","value":"b41770b0-5503-11eb-9a67-59113aa55d66"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"596","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"id\": \"b41770b0-5503-11eb-9a67-59113aa55d66\",\n \"name\": \"Example config\",\n \"description\": \"Configuration for talking to example server\",\n \"headers\": {\n \"Content-type\": \"application/json\",\n \"MyCustomHeader\": \"my custom header value\"\n },\n \"authHeaders\": {\n \"Username\": \"da/RnR8AHMOhJQ/zJdmKGzpDHDb6cczk/AWhd7j/p7q6HcdWspPEEh3+jNJ3uo9s\",\n \"Authentication\": \"WPdfm62AVZHioHru39380eJNOoWbH86ZqV6Uv/Q0LlvIHJQt1n4YSvGj0QuSLYiQUNW6ZglLRoirDWtZys9PRQ==\",\n \"Password\": \"fut4AWqUdggTxhVQGyj2eZtfpcG6+gQCDFqYQVK7F+ceFvZx5Tk9kX4OdCDJtwbR\"\n }\n }\n ]\n}"}],"_postman_id":"90384871-9b9c-45b0-9815-2c5fae8f0784"},{"name":"Delete Webhook Common Configuration by Id","id":"ba30e455-aeb8-40d2-a6e9-38a7b0d610e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/callback/authentication/:callbackAuthId/","description":"

Edits a common configuration

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","callback","authentication",":callbackAuthId",""],"host":["{{url}}"],"query":[],"variable":[{"id":"73820f64-fd92-4975-8a53-51d3005b4aaa","type":"any","value":"b41770b0-5503-11eb-9a67-59113aa55d66","key":"callbackAuthId"}]}},"response":[{"id":"e18e725a-b5dd-45e9-a3e2-64920493296d","name":"Sample Request","originalRequest":{"method":"DELETE","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/callback/authentication/:callbackAuthId/","host":["{{url}}"],"path":["v4","callback","authentication",":callbackAuthId",""],"variable":[{"key":"callbackAuthId","value":"b41770b0-5503-11eb-9a67-59113aa55d66"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"596","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"id\": \"b41770b0-5503-11eb-9a67-59113aa55d66\",\n \"name\": \"Example config\",\n \"description\": \"Configuration for talking to example server\",\n \"headers\": {\n \"Content-type\": \"application/json\",\n \"MyCustomHeader\": \"my custom header value\"\n },\n \"authHeaders\": {\n \"Username\": \"da/RnR8AHMOhJQ/zJdmKGzpDHDb6cczk/AWhd7j/p7q6HcdWspPEEh3+jNJ3uo9s\",\n \"Authentication\": \"WPdfm62AVZHioHru39380eJNOoWbH86ZqV6Uv/Q0LlvIHJQt1n4YSvGj0QuSLYiQUNW6ZglLRoirDWtZys9PRQ==\",\n \"Password\": \"fut4AWqUdggTxhVQGyj2eZtfpcG6+gQCDFqYQVK7F+ceFvZx5Tk9kX4OdCDJtwbR\"\n }\n }\n ]\n}"}],"_postman_id":"ba30e455-aeb8-40d2-a6e9-38a7b0d610e0"},{"name":"Get All Webhook Configurations","id":"a502ec2b-dfc3-400d-ba50-120fe398fac3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/callback/configuration/","description":"

Gets all callback configurations.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","callback","configuration",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3a8e430c-3b52-4424-a49c-89d7c59710c3","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":"{{url}}/v4/callback/configuration/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"594","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"eventType\": \"campaign_workflow_callback\",\n \"id\": \"b490c8e0-24ff-11eb-9ddd-a51d8cc0e304\",\n \"name\": \"WF Test\",\n \"callbackServerConfigId\": \"355c2d70-408a-11eb-bf2c-419a0ebdd348\",\n \"enabled\": true,\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"url\": \"https://yourdomain.com\",\n \"httpMethod\": \"POST\",\n \"contentType\": \"JSON\",\n \"bodyTemplate\": \"{\\n\\\"phone\\\":\\\"%PHONENUMBER1%\\\"\\n}\",\n \"successPath\": \"HTTP_OK\",\n \"successValue\": \"\"\n }\n ]\n}"}],"_postman_id":"a502ec2b-dfc3-400d-ba50-120fe398fac3"},{"name":"Add Webhook Configuration","id":"f0cac343-3e5b-4011-8269-34651cca7aa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"eventType\": \"campaign_workflow_callback\",\n \"name\": \"server callback\",\n \"enabled\": true,\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"url\": \"https://www.example.com/callbackUrl\",\n \"httpMethod\": \"POST\",\n \"contentType\": \"JSON\",\n \"bodyTemplate\": \"{ \\\"user\\\": \\\"%CONTACT_ID%\\\" }\",\n \"successPath\": \"$.status\",\n \"successValue\": \"true\",\n \"responseMapping\": {\n \"firstname\": \"$.user.firstname\",\n \"lastname\": \"$.user.lastname\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/callback/configuration/","description":"

Creates a new callback configuration.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","callback","configuration",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f9d28123-f9b2-40ef-a107-7df3c18c7e3e","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"eventType\": \"campaign_workflow_callback\",\n \"name\": \"server callback\",\n \"enabled\": true,\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"url\": \"https://www.example.com/callbackUrl\",\n \"httpMethod\": \"POST\",\n \"contentType\": \"JSON\",\n \"bodyTemplate\": \"{ \\\"user\\\": \\\"%%CONTACT_ID%%\\\" }\",\n \"successPath\": \"$.status\",\n \"successValue\": \"true\",\n \"responseMapping\": {\n \"firstname\": \"$.user.firstname\",\n \"lastname\": \"$.user.lastname\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/callback/configuration/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"533","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"eventType\": \"campaign_workflow_callback\",\n \"id\": \"93c9d4f0-55bd-11eb-8a79-2920273e2f39\",\n \"name\": \"server callback\",\n \"enabled\": true,\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"url\": \"https://www.example.com/callbackUrl\",\n \"httpMethod\": \"POST\",\n \"contentType\": \"JSON\",\n \"bodyTemplate\": \"{ \\\"user\\\": \\\"%CONTACT_ID%\\\" }\",\n \"responseMapping\": {\n \"firstname\": \"$.user.firstname\",\n \"lastname\": \"$.user.lastname\"\n },\n \"successPath\": \"$.status\",\n \"successValue\": \"true\"\n }\n ]\n}"}],"_postman_id":"f0cac343-3e5b-4011-8269-34651cca7aa7"},{"name":"Edit Webhook Configuration","id":"792d7294-75dd-4388-b813-12dba1ed6cb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

Edits an existing callback configuration.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","callback","configuration",":callbackId",""],"host":["{{url}}"],"query":[],"variable":[{"id":"ff66bf19-a65c-466b-b2b7-53bfc62c3ed6","type":"any","value":"93c9d4f0-55bd-11eb-8a79-2920273e2f39","key":"callbackId"}]}},"response":[{"id":"34a61900-37a1-4acc-bf06-4ef8cb39d1b7","name":"Sample Request","originalRequest":{"method":"PUT","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"eventType\": \"campaign_workflow_callback\",\n \"name\": \"server callback\",\n \"enabled\": true,\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"url\": \"https://www.example.com/callbackUrl\",\n \"httpMethod\": \"POST\",\n \"contentType\": \"JSON\",\n \"bodyTemplate\": \"{ \\\"user\\\": \\\"%%CONTACT_ID%%\\\" }\",\n \"successPath\": \"$.status\",\n \"successValue\": \"true\",\n \"responseMapping\": {\n \"firstname\": \"$.user.firstname\",\n \"lastname\": \"$.user.lastname\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v4/callback/configuration/:callbackId/","host":["{{url}}"],"path":["v4","callback","configuration",":callbackId",""],"variable":[{"key":"callbackId","value":"93c9d4f0-55bd-11eb-8a79-2920273e2f39"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"533","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"eventType\": \"campaign_workflow_callback\",\n \"id\": \"93c9d4f0-55bd-11eb-8a79-2920273e2f39\",\n \"name\": \"server callback\",\n \"enabled\": true,\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"url\": \"https://www.example.com/callbackUrl\",\n \"httpMethod\": \"POST\",\n \"contentType\": \"JSON\",\n \"bodyTemplate\": \"{ \\\"user\\\": \\\"%CONTACT_ID%\\\" }\",\n \"responseMapping\": {\n \"firstname\": \"$.user.firstname\",\n \"lastname\": \"$.user.lastname\"\n },\n \"successPath\": \"$.status\",\n \"successValue\": \"true\"\n }\n ]\n}"}],"_postman_id":"792d7294-75dd-4388-b813-12dba1ed6cb8"},{"name":"Get Webhook Configuration by Id","id":"4a5133e6-1b6d-47d6-9ba3-92a283831f78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/callback/configuration/:callbackId/","description":"

Edits an existing callback configuration.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","callback","configuration",":callbackId",""],"host":["{{url}}"],"query":[],"variable":[{"id":"03e8733d-7d11-46fc-8291-bdd2884a0f23","type":"any","value":"93c9d4f0-55bd-11eb-8a79-2920273e2f39","key":"callbackId"}]}},"response":[{"id":"d2c3f264-030c-453a-92c8-5c5e11a1cc90","name":"Get Webhook Configuration by Id","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/callback/configuration/:callbackId/","host":["{{url}}"],"path":["v4","callback","configuration",":callbackId",""],"variable":[{"key":"callbackId","value":"93c9d4f0-55bd-11eb-8a79-2920273e2f39"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"533","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"eventType\": \"campaign_workflow_callback\",\n \"id\": \"93c9d4f0-55bd-11eb-8a79-2920273e2f39\",\n \"name\": \"server callback\",\n \"enabled\": true,\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"url\": \"https://www.example.com/callbackUrl\",\n \"httpMethod\": \"POST\",\n \"contentType\": \"JSON\",\n \"bodyTemplate\": \"{ \\\"user\\\": \\\"%%CONTACT_ID%%\\\" }\",\n \"responseMapping\": {\n \"firstname\": \"$.user.firstname\",\n \"lastname\": \"$.user.lastname\"\n },\n \"successPath\": \"$.status\",\n \"successValue\": \"true\"\n }\n ]\n}"}],"_postman_id":"4a5133e6-1b6d-47d6-9ba3-92a283831f78"},{"name":"Delete Webhook Configuration","id":"a1a58259-3198-4716-bdd8-1032d4eee80c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/callback/configuration/:callbackId/","description":"

Edits an existing callback configuration.

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","callback","configuration",":callbackId",""],"host":["{{url}}"],"query":[],"variable":[{"id":"6ff8a86d-cc5b-4d1e-aec4-856f319be837","type":"any","value":"93c9d4f0-55bd-11eb-8a79-2920273e2f39","key":"callbackId"}]}},"response":[{"id":"3b1a2ccd-9c81-4af9-b58b-1931197a2851","name":"Sample Request","originalRequest":{"method":"DELETE","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/callback/configuration/:callbackId/","host":["{{url}}"],"path":["v4","callback","configuration",":callbackId",""],"variable":[{"key":"callbackId","value":"93c9d4f0-55bd-11eb-8a79-2920273e2f39"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"533","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"eventType\": \"campaign_workflow_callback\",\n \"id\": \"93c9d4f0-55bd-11eb-8a79-2920273e2f39\",\n \"name\": \"server callback\",\n \"enabled\": true,\n \"headers\": {\n \"Content-Type\": \"application/json\"\n },\n \"url\": \"https://www.example.com/callbackUrl\",\n \"httpMethod\": \"POST\",\n \"contentType\": \"JSON\",\n \"bodyTemplate\": \"{ \\\"user\\\": \\\"%%CONTACT_ID%%\\\" }\",\n \"responseMapping\": {\n \"firstname\": \"$.user.firstname\",\n \"lastname\": \"$.user.lastname\"\n },\n \"successPath\": \"$.status\",\n \"successValue\": \"true\"\n }\n ]\n}"}],"_postman_id":"a1a58259-3198-4716-bdd8-1032d4eee80c"}],"id":"53844db5-83b3-4635-88d9-e65c74d89778","description":"

Callbacks allow for Ytel to make HTTP requests to specified URLs when various events happen. Callbacks are composed of two components, a common configuration which can be shared among multiple callbacks and the actual configuration for the callback.

The common configuration stores common header information that can be stored either in plain text or encrypted. An example payload for a new configuration:

{\n  \"name\": \"Example config\",\n  \"description\": \"Configuration for talking to example server\",\n  \"headers\": {\n      \"Content-type\": \"application/json\",\n      \"MyCustomHeader\": \"my custom header value\"\n  },\n  \"authHeaders\": {\n      \"Authentication\": \"Bearer %%ACCESS_TOKEN%%\",\n      \"Username\": \"server username\",\n      \"Password\": \"server password\",\n  }\n}\n\n

name: Name of the common configuration
\n
description: Description of the common configuration
\n
headers: A key/value map of headers that will be sent as part of the callback.
\n
authHeaders: A key/value map of headers that will be sent as part of the callback. The values for this will be encrypted and are only decrypted when preparing to send a callback.
\n

All headers support Ytel's standard variable replacement.

For a callback to be set up it takes a payload that looks like:

{\n    \"eventType\": \"campaign_workflow_callback\",\n    \"name\": \"server callback\",\n    \"callbackServerConfigId\": \"deafbeef-1234-5555-abba-cab0fade4de7\",\n    \"enabled\": true,\n    \"headers\": {\n        \"Content-Type\": \"application/json\"\n    },\n    \"url\": \"https://www.example.com/callbackUrl\",\n    \"httpMethod\": \"POST\",\n    \"contentType\": \"JSON\",\n    \"bodyTemplate\": \"{ \\\"user\\\": \\\"%%CONTACT_ID%%\\\" }\",\n    \"successPath\": \"$.status\",\n    \"successValue\": \"true\",\n    \"responseMapping\": {\n        \"firstname\": \"$.user.firstname\",\n        \"lastname\": \"$.user.lastname\"\n    }\n}\n\n

eventType: The name of the event type that this callback is configured for.
\n
name: Friendly name for this callback.
\n
callbackServerConfigId: Id of the common configuration.
\n
enabled: True/False for whether this callback is enabled.
\n
headers: Additional headers or overrides of values in the common configuration.
\n
url: Url that will be hit when the callback is executed.
\n
httpMethod: HTTP method that will be used for the callback. Supports GET, POST, PUT, DELETE.
\n
bodyTemplate: The body that will be sent for POST or PUT requests.
\n
successPath: This should either be HTTP_OK for requests where a 2xx response is sufficient to mark success or the JsonPath path for where the success status is in the response.
\n
successValue: If successPath is not HTTP_OK, this is the expected value.
\n
responseMapping: key/value pairs of variables that should be set from the response. This is only relevant for some callbacks where data needs to be recorded from the callback.
\n

Headers and bodyTemplates both support the standard Ytel variable replacement.

Currently supported event_types are call_completion, call_dialing, call_in_progress, call_threshold, call_threshold_reset, campaign_status, campaign_workflow_callback, conference_start, conference_end, conference_guest_join, conference_guest_exit, dispo_status, inroute, live_list_status, recording, sms_inbound, sms_outbound, voicemail and webrtc_user_status. The campaign_workflow_callback is a configuration for use with the callback node in a workflow. The others will trigger a callback every time an event of that type happens. Documentation for the campaign_workflow_callback is covered in the node descriptions for workflows as it is slightly different from the others. The inroute callback is triggered with each event that checks for inbound routing and is documented in the inbound routing section.

All of the callbacks support a variable replacement for a variable called payload. This is raw JSON for the event and is non-configurable. Alternatively the individual fields can be accessed via variable replacement.

call_in_progress, call_dialing, and call_completion share the following variables: callsid, apiversion, billcountry, calltype, callednumber, callernumber, callduration, createdtime, direction, duration, endtime, fromcountry, parentcallsid, serverip, status, tocountry, tocountrycode, rvmcallerid, voicemailstatus, webrtcusername, hangupby, dtmfentered, and metadata. Additionally the key-value pairs from metadata are provided in the form metadata.key. Not all of these values are applicable for each of the events. call_dialing is fired when a call is dialed. call_in_progress is fired when there is an answer from the called number. call_completion is fired when a call is finished.

call_threshold and call_threshold_reset share the following variables: phonenumber, thresholdmet, and resettimems. The thresholdmet will be set to true if the configured threshold has been met for a phone number and will be false when the reset time has been reached. The resettimems is the time that the threshold reset message will be sent.

campaign_status supports the following variables: accountsid, contactid, campaignid, campaignrunid, campaignpath, workflowversion, nextnode, status, lastphone, failurereason. This event is fired anytime a workflow pauses or completes.

conference_start, conference_end, conference_guest_join, and conference_guest_exit share the following variables: confid, callsid, guesttoken, shceduleid, serverip, and miniconf.

dispo_status supports the following variables: callsid, smssid, to, from, dispositions, and dispotimems.

live_list_status supports the following variables: accountsid, clientid, listname, length, and status. This event is fired when a list is created, deleted, or the last entry in a list is removed.

recording supports the following variables:
accountsid, callsid, recordingid, apiversion, actionperformed, _actionmethod,_duration, fileuploadstatus, isactive, isrequest, recordingdate, recordingdirection, recordingurl, request, response, webrtcusername, calltype, parentcalltype, parentcallsid. This event is fired anytime a call is recorded.

sms_inbound supports the following variables: to, from, body. This event is fired any time an sms is received.

sms_outbound supports the following variables: accountsid, smsid, to, from, body, messagecount, mediaurl, messagecount, tocountry, fromcountry, metadata. This event is fired any time an sms is sent.

voicemail supports the following variables: recordingid, accountsid, phonenumber, fromnumber, seconds, url, transcription, status, and metadata. This event is fired anytime a voicemail is recorded.

webrtc_user_status supports the following variables: clientid, accountsid, status. This event is fired when a user logs into the webphone, logs out of the webphone, or manually changes their status.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2f0df69f-6565-481d-892c-4b21f1e11a1d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"aa6fc57f-4851-46d5-b089-dd9893d6b5cb"}}],"_postman_id":"53844db5-83b3-4635-88d9-e65c74d89778","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Workflows","item":[{"name":"Campaigns","item":[{"name":"Get Campaigns","id":"fd887959-708f-4eb2-b6b2-551ef7939e44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/campaign/","description":"

Retrieve all Campaigns

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaignName\": \"My First Campaign Test\",\r\n \"numberSet\": \"9c3080b2-9ba7-4d76-b362-60ec4c9bdeec\",\r\n \"timezoneProtectionType\": 0,\r\n \"workflowDisplayType\": 1\r\n}"},"url":"{{url}}/v4/campaign/","description":"

Adds a new campaign.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/campaign/report/?startDate=2021-01-15&endDate=2021-01-16&grouping=date","description":"

Gets a report of the performance and cost of one or more campaigns. This endpoint is intended to be used by the UI.

Parameters:

campaignId: Optional. Get a report for a single campaign. If not present will retrieve all.
templateId: Optional. Get a report for all campaigns that use the given sms template.
startDate: Optional. Format is YYYY-MM-DD. Will default to 30 days prior to endDate or the last 30 days if not present.
endDate: Optional. Format is YYYY-MM-DD. Will default to 30 days after startDate* or today if it isn't present.
grouping: Optional. How to group results. Options: campaign, template, date. If not present will return 1 row with all results.

Response:

campaignId: Id of the campaign
campaignName: Name of the campaign
sends: Number of times this campaign generated a billable outbound event. A campaign that sends multiple messages will over time will have multiple entries.
replies: Number of inbound messages to this campaign.
optOuts: Number of DNC requests this campaign has received.
cost: Base cost of the campaign. Does not include surcharge.
surcharge: Surcharges that resulted from this campaign.

startDate in format YYYY-MM-DD

\n","type":"text/plain"},"key":"startDate","value":"2021-01-15"},{"description":{"content":"

endDate in format YYYY-MM-DD

\n","type":"text/plain"},"key":"endDate","value":"2021-01-16"},{"description":{"content":"

comma separated list of date, campaign, and/or template

\n","type":"text/plain"},"key":"grouping","value":"date"}],"variable":[]}},"response":[{"id":"45543cb9-5a60-4a83-9e41-2312882a6684","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/campaign/report/?startDate=2021-01-15&endDate=2021-01-16&grouping=date","host":["{{url}}"],"path":["v4","campaign","report",""],"query":[{"key":"startDate","value":"2021-01-15","description":"startDate in format YYYY-MM-DD"},{"key":"endDate","value":"2021-01-16","description":"endDate in format YYYY-MM-DD"},{"key":"grouping","value":"date","description":"comma separated list of date, campaign, and/or template"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"214","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 2,\n \"page\": 1,\n \"payload\": [\n {\n \"sends\": 287,\n \"replies\": 0,\n \"optOuts\": 0,\n \"cost\": 0,\n \"surcharge\": 0,\n \"day\": \"2021-01-15\"\n },\n {\n \"sends\": 287,\n \"replies\": 0,\n \"optOuts\": 0,\n \"cost\": 0,\n \"surcharge\": 0,\n \"day\": \"2021-01-16\"\n }\n ]\n}"}],"_postman_id":"adfd05fb-256d-46d0-a5f3-f7e122c992ba"},{"name":"Edit Campaign","id":"c5413480-4a39-44ab-b936-d6e5de2f1596","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaignName\": \"New campaign name\",\r\n \"numberSet\": \"9c3080b2-9ba7-4d76-b362-60ec4c9bdeec\",\r\n \"timezoneProtectionEndTime\": \"22:00:00\",\r\n \"timezoneProtectionStartTime\": \"08:00:00\",\r\n \"timezoneProtectionTimezoneFixed\": -20,\r\n \"timezoneProtectionType\": 1,\r\n \"workflowDisplayType\": 1\r\n}"},"url":"{{url}}/v4/campaign/:campaignId/","description":"

Edit a campaign.

The campaignId to edit

\n","type":"text/plain"},"type":"any","value":"165c6fa0-59c8-11eb-a080-51e25f7d5918","key":"campaignId"}]}},"response":[{"id":"3e678909-90aa-49a1-aaaf-f14ec84d144f","name":"Sample Request","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaignName\": \"New campaign name\",\r\n \"numberSet\": \"9c3080b2-9ba7-4d76-b362-60ec4c9bdeec\",\r\n \"timezoneProtectionEndTime\": \"22:00:00\",\r\n \"timezoneProtectionStartTime\": \"08:00:00\",\r\n \"timezoneProtectionTimezoneFixed\": -20,\r\n \"timezoneProtectionType\": 1,\r\n \"workflowDisplayType\": 1\r\n}"},"url":{"raw":"{{url}}/v4/campaign/:campaignId/","host":["{{url}}"],"path":["v4","campaign",":campaignId",""],"variable":[{"key":"campaignId","value":"165c6fa0-59c8-11eb-a080-51e25f7d5918","description":"The campaignId to edit"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"477","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"campaignId\": \"165c6fa0-59c8-11eb-a080-51e25f7d5918\",\n \"campaignName\": \"New campaign name\",\n \"sends\": 0,\n \"clicks\": 0,\n \"replies\": 0,\n \"optOuts\": 0,\n \"cost\": 0,\n \"numberSet\": \"9c3080b2-9ba7-4d76-b362-60ec4c9bdeec\",\n \"timezoneProtectionType\": 1,\n \"timezoneProtectionTimezoneFixed\": -20,\n \"timezoneProtectionStartTime\": \"08:00\",\n \"timezoneProtectionEndTime\": \"22:00\",\n \"workflowDisplayType\": 1,\n \"workflowVersion\": 0\n }\n ]\n}"}],"_postman_id":"c5413480-4a39-44ab-b936-d6e5de2f1596"},{"name":"Get Campaign","id":"5ffa8394-5f48-4d7c-b98b-cacfacf27a82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/campaign/:campaignId/","description":"

Get the details of a single campaign.

The campaignId to view

\n","type":"text/plain"},"type":"any","value":"165c6fa0-59c8-11eb-a080-51e25f7d5918","key":"campaignId"}]}},"response":[{"id":"c8ca3b62-c5b5-415b-9261-e7663ff79aba","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/campaign/:campaignId/","host":["{{url}}"],"path":["v4","campaign",":campaignId",""],"variable":[{"key":"campaignId","value":"165c6fa0-59c8-11eb-a080-51e25f7d5918","description":"The campaignId to view"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"477","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"campaignId\": \"165c6fa0-59c8-11eb-a080-51e25f7d5918\",\n \"campaignName\": \"New campaign name\",\n \"sends\": 0,\n \"clicks\": 0,\n \"replies\": 0,\n \"optOuts\": 0,\n \"cost\": 0,\n \"numberSet\": \"9c3080b2-9ba7-4d76-b362-60ec4c9bdeec\",\n \"timezoneProtectionType\": 1,\n \"timezoneProtectionTimezoneFixed\": -20,\n \"timezoneProtectionStartTime\": \"08:00\",\n \"timezoneProtectionEndTime\": \"22:00\",\n \"workflowDisplayType\": 1,\n \"workflowVersion\": 0\n }\n ]\n}"}],"_postman_id":"5ffa8394-5f48-4d7c-b98b-cacfacf27a82"},{"name":"Send Campaign","id":"8300eb8f-9d69-4a02-880b-4c1670b660ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaignExtData\": {\r\n \"variablename\": \"campaign send\"\r\n },\r\n \"contactId\": \"da54d682-4d48-4f13-a4ee-07c850c05bb8\"\r\n}"},"url":"{{url}}/v4/campaign/:campaignId/send","description":"

Triggers the sending of a campaign. When sending a campaign it will either start the campaign immediately or queue it for sending if it is currently outside of timezone protection. Be aware that queueing multiple messages to send at the very beginning of timezone protection may run into queueing issues if there is insufficient capacity.

We recommend sending based on a contactId. If not provided, then a Contact will be created based upon the extData provided.

In the event of a conflict either the behavior depends on the conflictMode (default OVERWRITE) to either REJECT, OVERWRITE, or APPEND extData and keys for the existing contact.

If creating a new contact extData is required. keys is highly recommended, though some of these will be generated from extData. Refer to the Contacts section for more details.

For data that is relevant only to the campaign campaignExtData should be used. When evaluating a campaign, the campaignExtData is used preferentially over the extData stored on the contact.

campaignId

\n","type":"text/plain"},"type":"any","value":"165c6fa0-59c8-11eb-a080-51e25f7d5918","key":"campaignId"}]}},"response":[{"id":"1acb1e3a-54d1-4fa9-a6db-a38367cb30da","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaignExtData\": {\r\n \"variablename\": \"campaign send\"\r\n },\r\n \"contactId\": \"da54d682-4d48-4f13-a4ee-07c850c05bb8\"\r\n}"},"url":{"raw":"{{url}}/v4/campaign/:campaignId/send","host":["{{url}}"],"path":["v4","campaign",":campaignId","send"],"variable":[{"key":"campaignId","value":"165c6fa0-59c8-11eb-a080-51e25f7d5918","description":"campaignId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"266","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"campaignId\": \"165c6fa0-59c8-11eb-a080-51e25f7d5918\",\n \"version\": 0,\n \"contactId\": \"da54d682-4d48-4f13-a4ee-07c850c05bb8\",\n \"campaignExtData\": {\n \"variablename\": \"campaign send\"\n }\n }\n ]\n}"}],"_postman_id":"8300eb8f-9d69-4a02-880b-4c1670b660ac"},{"name":"Archive Campaign","id":"73d6260a-53db-4208-8bb8-d08b1eb7a070","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v4/campaign/:campaignId","description":"

Archives a campaign. Like other archive endpoints, there is no way to search for archived items.

The campaignId you want to archive

\n","type":"text/plain"},"type":"any","value":"165c6fa0-59c8-11eb-a080-51e25f7d5918","key":"campaignId"}]}},"response":[{"id":"8af4ddcb-31d8-4943-af08-61862f837517","name":"Sample Request","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v4/campaign/:campaignId","host":["{{url}}"],"path":["v4","campaign",":campaignId"],"variable":[{"key":"campaignId","value":"165c6fa0-59c8-11eb-a080-51e25f7d5918","description":"The campaignId you want to archive"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"477","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"campaignId\": \"165c6fa0-59c8-11eb-a080-51e25f7d5918\",\n \"campaignName\": \"New campaign name\",\n \"sends\": 0,\n \"clicks\": 0,\n \"replies\": 0,\n \"optOuts\": 0,\n \"cost\": 0,\n \"numberSet\": \"9c3080b2-9ba7-4d76-b362-60ec4c9bdeec\",\n \"timezoneProtectionType\": 1,\n \"timezoneProtectionTimezoneFixed\": -20,\n \"timezoneProtectionStartTime\": \"08:00\",\n \"timezoneProtectionEndTime\": \"22:00\",\n \"workflowDisplayType\": 1,\n \"workflowVersion\": 0\n }\n ]\n}"}],"_postman_id":"73d6260a-53db-4208-8bb8-d08b1eb7a070"},{"name":"Unarchive Campaign","id":"e05cc7b6-0144-4e10-bc04-06bb2af509da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/v4/campaign/:campaignId/unarchive","description":"

Takes a campaign that had previously been archived and moves it back into usage.

The campaignId you would like to Unarchive

\n","type":"text/plain"},"type":"any","value":"165c6fa0-59c8-11eb-a080-51e25f7d5918","key":"campaignId"}]}},"response":[{"id":"922c1481-d4a7-42a4-8dbb-be94c65da94b","name":"Sample Request","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/v4/campaign/:campaignId/unarchive","host":["{{url}}"],"path":["v4","campaign",":campaignId","unarchive"],"variable":[{"key":"campaignId","value":"165c6fa0-59c8-11eb-a080-51e25f7d5918","description":"The campaignId you would like to Unarchive"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"477","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c307\",\n \"campaignId\": \"165c6fa0-59c8-11eb-a080-51e25f7d5918\",\n \"campaignName\": \"New campaign name\",\n \"sends\": 0,\n \"clicks\": 0,\n \"replies\": 0,\n \"optOuts\": 0,\n \"cost\": 0,\n \"numberSet\": \"9c3080b2-9ba7-4d76-b362-60ec4c9bdeec\",\n \"timezoneProtectionType\": 1,\n \"timezoneProtectionTimezoneFixed\": -20,\n \"timezoneProtectionStartTime\": \"08:00\",\n \"timezoneProtectionEndTime\": \"22:00\",\n \"workflowDisplayType\": 1,\n \"workflowVersion\": 0\n }\n ]\n}"}],"_postman_id":"e05cc7b6-0144-4e10-bc04-06bb2af509da"}],"id":"a2cbaf5c-7c98-4298-acda-461d392af289","description":"

Campaigns are a way to configure a series of configurable actions. With the exception of the send endpoint, all of these apis are best used through the UI.

Campaigns are composed of two different sets of endpoints. The endpoints in this section are related to high level configuration data for the campaign, whereas the endpoints in the workflow section are related to the workflow associated with a campaign.

Fields on a campaign:

campaignId: Internal id of the campaign. This value is a generated UUID.
campaignName: User visible name of the campaign.
lastUsed: Last time the campaign sent a message. Milliseconds since the epoch
numberSet: UUID of the number set for the campaign
timezoneProtectionType: O for none, 1 for recipient, 2 for fixed
timezoneProtectionFixed: timezoneId from Timezones endpoint. Required if timezoneProtectionType is 2
timezoneProtectionStartTime: Earliest time that a campaign can be sent. Format HH:MM:SS.
timezoneProtectionEndTime: Latest time that a campaign can be sent. Format HH:MM:SS.
workflowDisplayType: Key to the Ytel UI as to how to display the campaign
workflowVersion: Latest version of the workflow. This monotonically increases with each new version of the workflow associated with the campaign.

Deprecated and unused fields:

sends, clicks, replies, optOuts, cost

Timezone protection will prevent sending of campaigns outside of the configured timezone protection times. For example if timezone protection is set between 9am and 5pm of the recipient's timezone then a campaign start that is received at 8:30am will be delayed until 9am.

\n","_postman_id":"a2cbaf5c-7c98-4298-acda-461d392af289","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Get Workflow","id":"ad56d0d2-03d2-45a1-850c-c00512556c8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/campaign/:campaignId/workflow","description":"

Retrieves the most recent workflow version for a campaign

The Campaign ID of the workflow you would like to get

\n","type":"text/plain"},"type":"any","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","key":"campaignId"}]}},"response":[{"id":"f2246bba-3f50-478a-9546-feac04584717","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/campaign/:campaignId/workflow","host":["{{url}}"],"path":["v4","campaign",":campaignId","workflow"],"variable":[{"key":"campaignId","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","description":"The Campaign ID of the workflow you would like to get"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"259","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"campaignId\": \"24926fc0-59c8-11eb-a850-5d6f7436c35b\",\n \"version\": 2,\n \"workflow\": \"{\\\"schemaVersion\\\":1,\\\"startNode\\\":1,\\\"nodes\\\":[{\\\"id\\\":1,\\\"type\\\":\\\"control\\\"}]}\"\n }\n ]\n}"}],"_postman_id":"ad56d0d2-03d2-45a1-850c-c00512556c8f"},{"name":"Add workflow","id":"167cb252-9d26-47e0-9cf2-f542ce18808a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"workflow\": \"{\\\"schemaVersion\\\":1,\\\"startNode\\\":1,\\\"nodes\\\":[{\\\"id\\\":1,\\\"type\\\":\\\"smsSend\\\",\\\"smsTemplateId\\\":\\\"34ad8f70-3a5d-11e9-8399-fb8e8d19e153\\\"}]}\"\r\n}"},"url":"{{url}}/v4/campaign/:campaignId/workflow","description":"

Add a new campaign workflow. Refer to the notes for Workflow. In general creating or editing a workflow is best done through the UI rather than programmatically through the API.

The Campaign ID of the workflow you would like to add the workflow to

\n","type":"text/plain"},"type":"any","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","key":"campaignId"}]}},"response":[{"id":"34d0cca8-cb5b-4ec6-bc5e-b2a000fb6dec","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"workflow\": \"{\\\"schemaVersion\\\":1,\\\"startNode\\\":1,\\\"nodes\\\":[{\\\"id\\\":1,\\\"type\\\":\\\"smsSend\\\",\\\"smsTemplateId\\\":\\\"34ad8f70-3a5d-11e9-8399-fb8e8d19e153\\\"}]}\"\r\n}"},"url":{"raw":"{{url}}/v4/campaign/:campaignId/workflow","host":["{{url}}"],"path":["v4","campaign",":campaignId","workflow"],"variable":[{"key":"campaignId","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","description":"The Campaign ID of the workflow you would like to add the workflow to"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"318","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"campaignId\": \"24926fc0-59c8-11eb-a850-5d6f7436c35b\",\n \"version\": 3,\n \"workflow\": \"{\\\"schemaVersion\\\":1,\\\"startNode\\\":1,\\\"nodes\\\":[{\\\"id\\\":1,\\\"type\\\":\\\"smsSend\\\",\\\"smsTemplateId\\\":\\\"34ad8f70-3a5d-11e9-8399-fb8e8d19e153\\\"}]}\"\n }\n ]\n}"}],"_postman_id":"167cb252-9d26-47e0-9cf2-f542ce18808a"},{"name":"Edit Workflow","id":"75386473-65d4-4553-b4a7-da465c55aaa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

Edit the workflow for a campaign. This is best done through the UI.

The Campaign ID that contains the workflow you would like to edit

\n","type":"text/plain"},"type":"any","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","key":"campaignId"}]}},"response":[{"id":"bfda8780-0eea-4a38-8205-286400ff5cb1","name":"Sample Request","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"workflow\": \"{\\\"schemaVersion\\\":1,\\\"startNode\\\":1,\\\"nodes\\\":[{\\\"id\\\":1,\\\"type\\\":\\\"smsSend\\\",\\\"smsTemplateId\\\":\\\"34ad8f70-3a5d-11e9-8399-fb8e8d19e153\\\"}]}\"\r\n}"},"url":{"raw":"{{url}}/v4/campaign/:campaignId/workflow","host":["{{url}}"],"path":["v4","campaign",":campaignId","workflow"],"variable":[{"key":"campaignId","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","description":"The Campaign ID that contains the workflow you would like to edit"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"318","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c307\",\n \"campaignId\": \"24926fc0-59c8-11eb-a850-5d6f7436c35b\",\n \"version\": 4,\n \"workflow\": \"{\\\"schemaVersion\\\":1,\\\"startNode\\\":1,\\\"nodes\\\":[{\\\"id\\\":1,\\\"type\\\":\\\"smsSend\\\",\\\"smsTemplateId\\\":\\\"34ad8f70-3a5d-11e9-8399-fb8e8d19e153\\\"}]}\"\n }\n ]\n}"}],"_postman_id":"75386473-65d4-4553-b4a7-da465c55aaa6"}],"id":"0b782301-0929-4940-ad1d-eaf7fd6fe43c","description":"

Campaign workflows define how a campaign will run once initiated. Modifying a workflow is most safely done through the UI. The workflow itself is stringified JSON.

This is an example (pre-stringified workflow):

{\n  \"schemaVersion\":1,\n  \"startNode\":1,\n  \"nodes\":[\n    {\n      \"id\":1,\n      \"type\":\"smsSend\",\n      \"children\":[2],\n      \"smsTemplateId\":\"8ebb25d0-bde9-11e9-a801-4bd9a183fd0d\"\n    },\n    {\n      \"id\":2,\n      \"type\":\"event\",\n      \"children\":[3,4,5],\n      \"timeoutData\":{\n        \"timeoutType\": \"wait\",\n        \"timeoutWaitNumber\":1,\n        \"timeoutWaitUnits\":\"minutes\",\n        \"timeoutTimezoneType\":\"recipient\",\n        \"timeoutTimezone\":null,\n        \"timeoutScheduleDate\":\"2020-03-10T16:58:15.855Z\",\n        \"timeoutPath\":5\n      },\n      \"conditions\":[\n        {\n          \"statements\":[\n            {\"variable\":\"node1.reply\",\"operation\":\"equals\",\"value\":\"1\"}\n          ],\n          \"path\":3\n         },\n         {\n           \"statements\":[\n             {\"variable\":\"\",\"operation\":\"equals\",\"value\":\"\"}\n           ],\"path\":4\n         }\n      ]\n    },\n    {\n      \"id\":3,\n      \"type\":\"smsSend\",\n      \"children\":[],\n      \"smsTemplateId\":\"0ade7370-be07-11e9-a801-4bd9a183fd0d\"\n    },\n    {\n      \"id\":4,\n      \"type\":\"smsSend\",\n      \"children\":[],\n      \"smsTemplateId\":\"d81bf5b0-ff48-11e9-877b-651da2c96fd9\"\n    },\n    {\n      \"id\":5,\n      \"type\":\"smsSend\",\n      \"children\":[6],\n      \"smsTemplateId\":\"636216f0-ef6c-11e9-b3f6-bba680f07a29\"\n    },\n    {\n      \"id\":6,\n      \"type\":\"timeDelay\",\n      \"children\":[7],\n      \"timeoutType\":\"wait\",\n      \"timeoutWaitNumber\":1,\n      \"timeoutWaitUnits\":\"minutes\",\n      \"timeoutTimezoneType\":\"recipient\",\n      \"timeoutTimezone\":null,\n      \"timeoutScheduleDate\":\"2020-03-10T22:17:21.185Z\"\n    },\n    {\n      \"id\":7,\n      \"type\":\"smsSend\",\n      \"children\":[],\n      \"smsTemplateId\":\"0ade7370-be07-11e9-a801-4bd9a183fd0d\"\n    }\n  ]\n}\n\n

Currently supported nodes types are:

agentQueue
\n
aiAssist
\n
call
\n
callback
\n
campaign
\n
carrierLookup
\n
computation
\n
condition
\n
control
\n
dnc
\n
dncCheck
\n
editContact
\n
email
\n
endRepeater
\n
event
\n
meme
\n
percentage
\n
random
\n
repeater
\n
section
\n
smsSend
\n
timeDelay
\n

AgentQueue (aka Live List)

The agentQueue node will add a contact into a live list. The name of the list must be provided in addition to a definition for how the contact will be expired. Valid values for expirationType are fixed and campaignTimezoneProtection. If the campaign timezone protection is used the contact expiration will be set to the end of the timezone protection time for the campaign. For fixed the contact will expire after a fixed period of time.

{\n  \"id\":7,\n  \"type\": \"agentQueue\",\n  \"children\": [9],\n  \"queueName\": \"testlist\",\n  \"expirationType\": \"fixed\",\n  \"expirationNumber\": 30,\n  \"expirationUnits\": \"minutes\"\n}\n\n

Ai Assist

The ai assist node will kick off a flow to interact with an AI agent. Execution will be paused on the workflow until the ai agent has completed. The aiAssistId is required.

Call

A call node will initiate a phone call. The supported parameters mirror those of the v4/call endpoint with the exception of specifying the to and from numbers, which will be taken from the workflow.

{\n  \"id\":7,\n  \"type\": \"call\",\n  \"children\": [9],\n  \"url\": \"https://customapps.ytel.com/m360/examples/welcome/index.php\"\n}\n\n

Callback (aka Webhook)

A callback node will make a call to a remote webserver. Using the configured callback. The callback itself must be of type campaign_workflow_callback.

When evaluating variables the standard variables are usable (contact extData and campaign extData). Additionally some contact and campaign related variables are populated. These are contact_creation_time_ms, contact_creation_time_iso, contact_phone, contact_id, campaign_id, campaign_phone, campaign_path, and campaign_run_id.

{\n  \"id\":4,\n  \"type\":\"callback\",\n  \"children\":[5],\n  \"callbackId\":\"0ade7370-be07-11e9-a801-4bd9a183fd0d\"\n}\n\n

Campaign

A campaign node will trigger the start of a different campaign. Uses for this include doing initial messaging within one campaign to gather opt-in data and then switching to a different campaign on a different set of numbers once a positive opt-in has been recorded.

{\n  \"id\":3,\n  \"type\":\"campaign\",\n  \"campaignId\":\"0ade7370-be07-11e9-a801-4bd9a183fd0d\",\n  \"children\":[4]\n}\n\n

CarrierLookup

This node performs a carrier lookup and populates campaign variables based upon the results. The following variables will be populated: phonenumber1.wireless, phonenumber1.city, phonenumber1.state, phonenumber1.country, phonenumber1.zip, phonenumber1.network, phonenumber1.company.

{\n  \"id\": 10,\n  \"type\": \"carrierLookup\",\n  \"children\": [11]\n}\n\n

Computation

A computation node will execute one or more FreeMarker or JsonPath expressions. Refer to documentation about FreeMarker and JsonPath for syntax.

{\n  \"id\": 11,\n  \"type\": \"computation\",\n  \"computations\": [\n    {\n      \"variable\": \"targetvariable1\",\n      \"type\": \"freemarker\",\n      \"freemarker\": \"freemarker expression\"\n    },\n    {\n      \"variable\": \"targetvariable2\",\n      \"type\": \"jsonpath\",\n      \"jsonPath\": \"$.path1.path2\",\n      \"jsonPathSourceVariable\": \"http_response_1\"\n    }\n  ]\n}\n\n

Condition

A condition node will evaluate the current status of a contact with any additional campaign specific extData. Conditions on the node are evaluated in order until a condition is matched. If no conditions are matched, the last child in the list of children will be executed. If there are multiple statements, all must be true for the associated path to be chosen.

{\n  \"id\":2,\n  \"type\":\"condition\",\n  \"children\":[3,4,5],\n  \"conditions\":[\n    {\n      \"statements\":[\n        {\"variable\":\"make\",\"operation\":\"equals\",\"value\":\"toyota\"},\n        {\"variable\":\"model\",\"operation\":\"equals\",\"value\":\"highlander\"}\n      ],\n      \"path\":3\n    },\n    {\n      \"statements\":[\n        {\"variable\":\"price\",\"operation\":\"greater_than\",\"value\":\"7000\"}\n      ],\n      \"path\":4\n    }\n  ]\n}\n\n

Supported operations are case insensitive and spaces are replaced with _ characters:

equals
\n
equals one of
\n
contains
\n
contains one of
\n
begins with
\n
ends with
\n
less than
\n
greater than
\n
exists
\n

Equals is an exact match, while Equals one of takes a comma separated list of items to do exact match queries against. Contains and Contains one of are similar to equals, but contains queries instead.

Control (aka Stop)

A control node is a no-op that will end execution of a campaign. This node may not have any children.

{\n  \"id\":2,\n  \"type\":\"control\",\n  \"children\":[]\n}\n\n

DNC

The Dnc node will add a contact to the appropriate dnc list. Valid values for dncType are all, sms, call.

{\n  \"id\": 13,\n  \"dncType\": \"all\"\n}\n\n

DNC Check

The dnc check node will check to see if a contact is on either the federal DNC or the account's dnc list and branch to the relevant path.

Valid values for dncList are account or federal. Valid values for subtype are call or sms. If a contact is on the relevant DNC list, the workflow will go to the matchPath route. Otherwise it will follow the noMatchPath route.

{\n  \"id\":10,\n  \"type\":\"dncCheck\",\n  \"dncList\":\"account\",\n  \"subtype\":\"sms\",\n  \"matchPath\":11,\n  \"noMatchPath\":12,\n  \"children\": [11,12]\n}\n\n

Edit Contact

Edit Contact nodes allow for permanently modifying a contact during a workflow. There can be multiple changes per node. Supported changes are clearing a field from a contact, adding a fixed value to a contact, or adding a variable from the campaign to a contact.

{\n  \"id\":3,\n  \"type\":\"editContact\",\n  \"children\":[],\n  \"assignments\":[\n    { \"mode\": \"clear\", \"variable\": \"needoptin\", \"value\": \"\" },\n    { \"mode\": \"assignFixed\", \"variable\": \"dogfactsoptin\", \"value\": \"true\" },\n    { \"mode\": \"assignVariable\", \"variable\": \"numdogs\", \"value\": \"node1.reply\" }\n  ]\n}\n\n

Email

Email nodes are used to send email via an external email provider. Currently only Hubspot, Mailgun, and Sendgrid are supported. For all providers a template must be set up in the external system.

In all cases the cc and bcc fields are optional. The subject and from are required for some providers. The replacements field specifies the key/value pairs that will be sent to the provider as replacements for the template.

{\n  \"id\": 18,\n  \"type\": \"email\",\n  \"children\": []\n  \"provider\": \"sendgrid\",\n  \"from\": {\n    \"email\": \"myemail@mydomain.com\",\n    \"name\": \"My friendly name\"\n  },\n  \"cc\": [\n    {\n      \"email\": \"myccemail@mydomain.com\",\n      \"name\": \"My CC friendly name\"\n    }\n  ],\n  \"subject\": \"My email subject\",\n  \"templateId\": \"templateId\",\n  \"replacements\": [\n     \"variable1\": \"fixed text\",\n     \"variable2\": \"%%VARIABLENAME%%\"\n  ]\n}\n\n

End Repeater

End Repeater nodes provide a condition that when matched will mark the parent repeater node as completed. These nodes will wait for an event similar to an event node.

{\n  \"id\": 16,\n  \"type\": \"endRepeater\",\n  \"children\": [],\n  \"conditions\": [\n    {\n      \"negated\": \"false\",\n      \"variable\": \"node15.reply\",\n      \"operation\": \"contains_one_of\",\n      \"value\": \"yes,ya,ok,yep\"\n    }\n  ]\n}\n\n

Event

Event nodes are a combination of a condition node and a timeDelay node. Similar to a condition node it has multiple execution paths, but will delay execution of conditions until an event happens or a timeout occurs. If at the initial time of execution the conditions are met, there will be no delay.

Within the timeoutData block, it mirrors the timeDelay node. Refer to the documentation of that node for how parameters work.

{\n  \"id\":2,\n  \"type\":\"event\",\n  \"children\":[3,4,5],\n  \"timeoutData\":{\n    \"timeoutType\": \"wait\",\n    \"timeoutWaitNumber\":1,\n    \"timeoutWaitUnits\":\"minutes\",\n    \"timeoutTimezoneType\":\"recipient\",\n    \"timeoutTimezone\":null,\n    \"timeoutScheduleDate\":\"2020-03-10T16:58:15.855Z\",\n    \"timeoutPath\":5\n  },\n  \"conditions\":[\n    {\n      \"statements\":[\n        {\"variable\":\"node1.reply\",\"operation\":\"equals\",\"value\":\"1\"}\n      ],\n      \"path\":3\n    },\n    {\n      \"statements\":[\n        {\"variable\":\"\",\"operation\":\"equals\",\"value\":\"\"}\n      ],\n      \"path\":4\n    }\n  ]\n}\n\n

Meme

The meme node generates an image with text suitable for use by a future sms node. The provided fileName must correspond to an asset that has been uploaded with the meme type. The name of the generated image url will be stored into the variable named storedVariableName. While messages is an array, only one message is currently supported.

{\n  \"id\":2,\n  \"type\":\"meme\",\n  \"children\":[3],\n  \"fileName\": \"memeFile.png\",\n  \"storedVariableName\": \"memeimage\",\n  \"messages\":[\n    {\n      \"xval\": 10,\n      \"yval\": 20,\n      \"font\": \"font\",\n      \"fontSize\": 12,\n      \"fontColor\": \"black\",\n      \"rotate\": 0,\n      \"message\": \"This is my message\"\n    }\n  ]\n}\n\n

Percentage

A percentage node chooses a path based upon the weights given to each path. Weights must be integers and for compatibility with the frontend are typically weighted in hundredths of a percent (ex: 2500, 4000, 3500 for 25%, 40%, and 35%) and will sum to 10,000.

{\n  \"id\":1,\n  \"type\":\"percentage\",\n  \"children\":[2,3],\n  \"percentages\":[5000,5000]\n}\n\n

Percentage

A random node chooses a child at random with equal weighting to all children.

{\n  \"id\":1,\n  \"type\":\"random\",\n  \"children\":[2,3]\n}\n\n

Repeater

A repeater node will start a series of loops over the nodes that follow it. Each loop will be spaced out over time until either a condition set by an end repeater node or the maximum number of attempts have been made. In all cases, after competion of a set of repeats, flow will continue with the selected section.

Configuration of a repeater node is similar to the configuration of a time delay node when configured in timezoneProtect mode.

{\n  \"id\": 40,\n  \"section\": \"nextSection\",\n  \"numAttempts\": 3,\n  \"maxDaily\": 2,\n  \"timezoneType\": \"recipient\",\n  \"allowedDaysOfWeek\": 127,\n  \"beginTime\": \"8:00 am\",\n  \"endTime\": \"5:00 pm\",\n  \"fixedTimezoneId\": -20,\n  \"minMinutesBetweenEvents\": 60\n}\n\n

Section

A section node will send a contact to a new section of the workflow to continue execution. Section nodes allow for multiple workflow paths to reconverge back to a single point to reduce the number of duplicate nodes needed in a workflow due to branching.

An example case where this is useful would be a condition node that checks to see if the firstname variable is populated on a contact. If it is not present a workflow path with an sms node followed by an event node and an edit contact node would be added followed by a section node to go to the next section. In the case where it was present the only child would be a section node to the next section.

{\n  \"id\": 1,\n  \"section\": \"lastname\"\n}\n\n

Within the workflow configuration a sections mapping must be added. This is an example workflow that starts with a random node that chooses between two paths, both containing a section node, and ends with the control node. Workflow paths for a contact send through this workflow will be either [1, 2, 4] or [1, 3, 4].

{\n  \"schemaVersion\":1,\n  \"startNode\":1,\n  \"sections\": [\n    { \"exit\": \"4\" }\n  ]\n  \"nodes\":[\n    {\n      \"id\": 1,\n      \"type\":\"random\",\n      \"children\": [2, 3]\n    },\n    {\n      \"id\": 2,\n      \"type\":\"section\",\n      \"section\": \"exit\"\n    },\n    {\n      \"id\": 3,\n      \"type\":\"section\",\n      \"section\": \"exit\"\n    },\n    {\n      \"id\": 4,\n      \"type\": \"control\"\n    }\n  ]\n\n

Sms Send

An sms send node will send an sms message using the specified sms template. When doing variable replacement by using variables passed in with the campaign and falling back to variables stored on the contact. In the event of a reply to an sms message a variable called nodeX.reply will be populated on the campaign, where X is the id of the sms send node. This variable can be used for conditions nodes or more commonly with event nodes.

{\n  \"id\":7,\n  \"type\":\"smsSend\",\n  \"children\":[],\n  \"smsTemplateId\":\"0ade7370-be07-11e9-a801-4bd9a183fd0d\"\n}\n\n

Time delay

A time delay node will wait for either a specified period of time or wait until a scheduled time. Valid values for timeoutType are wait, timezoneProtect, waitTime, scheduleTz, and schedule.

When set to wait the timeoutWaitUnits is required and one of timeoutWaitNumber and timeoutWaitVariable. This mode should be used to wait for a specific period of time (ex: 5 minutes).

When set to schedule requires either the timeoutScheduleDate or timeoutScheduleVariable to be set. This mode should be used to wait until a specific point in time. The format for the date should be in ISO8601 format. If it is a variable, it can also be in epoch millis.

The scheduleTz mode is similar to schedule, but also takes a timezoneType. In this mode the time is scheduled in the desired timezone instead of UTC.

When set to waitTime the timezoneType, fixedTimezoneId, and timeoutAllowedDays must be set and either the timeoutWaitUntilVariable or timeoutWaitUntilTime. The timezoneType must be set to eitehr recipient or fixed; when in recipient mode it will fall back to fixed if ther recipient's timezone cannot be determined. The timeoutAllowedDays variable is a bitmask for days of the week (1 = Sunday, 2, Monday, 4 Tuesday, etc.). This mode should be used when waiting until a particular time of day (ex: 8:00 am).

When set to timezoneProtect the timeRangeStart, timeRangeEnd, timezoneType, timeoutAllowedDays, and fixedTimezoneId all most be set. If the current time in the selected timezone is between timeRangeStart and timeRangeEnd during an allowed day then execution will proceed, otherwise execution will be paused until the first available time. This mode should be used to pause execution outside of a particular range of hours and/or days (ex: M-F 8:00am to 5:00pm).

{\n  \"id\":1,\n  \"type\":\"timeDelay\",\n  \"children\":[2],\n  \"timeoutType\":\"schedule\",\n  \"timeoutWaitNumber\":5,\n  \"timeoutWaitUnits\":\"minutes\",\n  \"timeoutTimezoneType\":\"recipient\",\n  \"timeoutTimezone\":null,\n  \"timeoutScheduleDate\":\"2020-04-01T22:40:52.907Z\"\n}\n\n

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"731fd28b-5f07-44c1-8d69-6a50e077b65c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"cd7e88cf-920a-4f56-8936-c9fb8baa77c8"}}],"_postman_id":"0b782301-0929-4940-ad1d-eaf7fd6fe43c","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Workflow Runner","item":[{"name":"Workflow Schedules","item":[{"name":"Add Schedule","id":"3f96ddbf-3b9b-404d-8f95-4960ba11af26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"nextScheduled\":null,\n \"status\":1,\n \"timezoneId\":-32,\n \"recurring\": true,\n \"periodNumber\": 1,\n \"periodUnits\": \"DAYS\",\n \"scheduleFailureMode\": 1,\n \"createBatchRequest\":{\n \"campaignId\":\"campaignId\",\n \"displayName\":\"My batch\",\n \"periodMs\":-1,\n \"start\":true,\n \"contactIds\":[\"contactId1\",\"contactId2\"]},\n \"filters\":{\"dnc\":[\"call\",\"sms\"]},\n \"dayOfWeek\":62,\n \"timeOfDay\":\"10:00\",\n \"expire\":1614388048\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/campaign/:campaignId/batch/schedule","description":"

Creates a new scheduled runner for the specified workflow.

Unique id

\n","type":"text/plain"},"type":"any","value":null,"key":"campaignId"}]}},"response":[],"_postman_id":"3f96ddbf-3b9b-404d-8f95-4960ba11af26"},{"name":"Edit Schedule","id":"2b8d9534-b964-4a32-8975-bf3c68296429","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"nextScheduled\":null,\n \"status\":1,\n \"timezoneId\":-32,\n \"recurring\": true,\n \"periodNumber\": 1,\n \"periodUnits\": \"DAYS\",\n \"scheduleFailureMode\": 1,\n \"createBatchRequest\":{\n \"campaignId\":\"campaignId\",\n \"displayName\":\"My batch\",\n \"periodMs\":-1,\n \"start\":true,\n \"contactIds\":[\"contactId1\",\"contactId2\"]},\n \"filters\":{\"dnc\":[\"call\",\"sms\"]\n },\n \"dayOfWeek\":62,\n \"timeOfDay\":\"10:00\",\n \"expire\":1614388048\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/campaign/:campaignId/batch/schedule/:scheduleId","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","campaign",":campaignId","batch","schedule",":scheduleId"],"host":["{{url}}"],"query":[],"variable":[{"id":"09b41c05-99e1-42e5-abc6-0162f154c1c4","type":"any","value":null,"key":"campaignId"},{"id":"093b0f22-0883-4c9b-8725-54e05a4a88b0","type":"any","value":null,"key":"scheduleId"}]}},"response":[],"_postman_id":"2b8d9534-b964-4a32-8975-bf3c68296429"},{"name":"Get Schedules","id":"348266ee-3cb8-4053-96e9-357dcfd5c495","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/campaign/batch/schedule","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","campaign","batch","schedule"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"348266ee-3cb8-4053-96e9-357dcfd5c495"}],"id":"65d29329-7964-47a8-8e02-96244000579b","description":"

Workflows can be scheduled to run at specific times and to recur with programmable intervals.

Fields:

accountSid: Account Id
campaignId: Workflow that will be triggered when the schedule runs
eventId: Unique identifier for the schedule
timeOfDay: Time of day that the schedule will run. Format is hh:mm:ss
timezoneId: Integer timezone id. Taken from the id of the timezone from the timezones endpoints.
createBatchRequest: Parameters for the request to start a runner. This exactly mirrors the body to create a single use runner.
nextScheduled: Next time this runner is scheduled to rune
lastRun: Last time this scheduled runner was executed.
recurring: Whether or not this scheduled run is recurring.
expire: When the recurring schedules will stop recurring.
dayOfWeek: Integer representing the days of the week this runner is allowed to run. This is a bitmask with Sunday being 1, Monday being 2, Tuesday being 4, etc.
dayOfMonth: Day of the month that the scheduled runner will run. Used in conjunction with a monthly period.
periodUnits: Increment type for scheduling future workflows. Valid values are days, weeks, or months.
periodNumber: Number of periodUnits that will be use for scheduling future workflows.
scheduleFailureMode: Which direction days should be incremented or decremented if the scheduled day either does not exist or is not a valid dayOfWeek. Valid values 1 and -1. Default 1.
frequencyDescription: Human description of what the frequency should be.
status: Whether the schedule is active or inactive. 1 is active.

The scheduleFailureMode in conjunction with monthly increments, day of week filters, and day of month setting will allow for pretty much any monthly schedule.

For example to schedule a workflow to run on the last day of the month the dayOfMonth should be set to 31 and the scheduleFailureMode should be set to -1. For the last business day of the month, it would be the same with a dayOfWeek filter set to 62 (for M-F).

To schedule on the second Saturday of every month either set dayOfMonth to 8 with a scheduleFailureMode of 1 or dayOfMonth to 13 with a scheduleFailureMode of -1. In both cases the dayOfWeek should be set to 64.

\n","_postman_id":"65d29329-7964-47a8-8e02-96244000579b","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Add Runner","id":"000b96b6-373d-48bf-a289-b00ef9200321","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"My runner\",\n \"contactIds\": [\n \"da54d682-4d48-4f13-a4ee-07c850c05bb8\"\n ],\n \"statements\": [\n {\n \"operation\": \"contains\",\n \"value\": \"Roy\",\n \"variable\": \"firstname\"\n }\n ],\n \"start\": \"true\",\n \"periodMs\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/campaign/:campaignId/batch","description":"

Initializes a new campaign workflow runner context. The context can be initialized using either a set of contactIds or a series of statements. The two fields are mutually exclusive. Documentation on how to use statements can be found in the Search Contacts section.

Request body variables:

displayName: Display name in the UI for this runner.
contactIds: List of contactIds that will be started in the workflow.
statements: List of statements that identify the contacts that will be started in the workflow. All contacts that match the query will be added.
start: If set to true, this will start the workflow. If not set or false it will not start the workflow and leave it in a non-started state. If periodMs is 0 the workflow will also not be started regardless of what this is set to.
periodMs: Delay between sends. If not set it will default to 0. Campaigns with this set to 0 cannot be started without setting this to a non-zero value, however they can be manually \"clicked\" through by using the batch/next endpoint detailed below.

The campaignId to enroll contacts into

\n","type":"text/plain"},"type":"any","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","key":"campaignId"}]}},"response":[{"id":"66de08be-401a-4409-ac03-04f804a2ec71","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"My runner\",\n \"contactIds\": [\n \"da54d682-4d48-4f13-a4ee-07c850c05bb8\"\n ],\n \"statements\": [\n {\n \"operation\": \"contains\",\n \"value\": \"Roy\",\n \"variable\": \"firstname\"\n }\n ],\n \"start\": \"true\",\n \"periodMs\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v4/campaign/:campaignId/batch","host":["{{url}}"],"path":["v4","campaign",":campaignId","batch"],"variable":[{"key":"campaignId","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","description":"The campaignId to enroll contacts into"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"286","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"campaignId\": \"24926fc0-59c8-11eb-a850-5d6f7436c35b\",\n \"batchId\": \"b2904860-59cd-11eb-b685-d322c09b20ac\",\n \"displayName\": \"My runner\",\n \"status\": \"Not started\",\n \"started\": 0,\n \"queued\": 1,\n \"periodMs\": 0\n }\n ]\n}"}],"_postman_id":"000b96b6-373d-48bf-a289-b00ef9200321"},{"name":"Edit Runner","id":"7775cd3b-21ad-4d9b-b39c-bff6d9e9801d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"My runner edited\",\n \"contactIds\": [\n \"da54d682-4d48-4f13-a4ee-07c850c05bb8\"\n ],\n \"statements\": [\n {\n \"operation\": \"contains\",\n \"value\": \"Roy\",\n \"variable\": \"firstname\"\n }\n ],\n \"start\": \"true\",\n \"periodMs\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/campaign/:campaignId/batch/:batchId","description":"

Updatess a campaign workflow runner context. The context can be initialized using either a set of contactIds or a series of statements. The two fields are mutually exclusive. Documentation on how to use statements can be found in the Search Contacts section. Note that after the workflow has already been started, no new contacts can be added to the runner.

Request body variables:

displayName: Display name in the UI for this runner.
contactIds: List of contactIds that will be started in the workflow.
statements: List of statements that identify the contacts that will be started in the workflow. All contacts that match the query will be added.
start: If set to true, this will start the workflow. If set to false it will stop a running workflow.
periodMs: Delay between sends. If not set it will default to 0. Changing the delay of a running workflow will do nothing.

Id of the campaign

\n","type":"text/plain"},"type":"any","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","key":"campaignId"},{"id":"55132590-6f93-4a7b-a6f0-4696af2ab02e","description":{"content":"

Id of the batch

\n","type":"text/plain"},"type":"any","value":"b2904860-59cd-11eb-b685-d322c09b20ac","key":"batchId"}]}},"response":[{"id":"ccb39ed4-33cb-4798-a8fe-e17a7d8b9785","name":"Sample Request","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"displayName\": \"My runner edited\",\n \"contactIds\": [\n \"da54d682-4d48-4f13-a4ee-07c850c05bb8\"\n ],\n \"statements\": [\n {\n \"operation\": \"contains\",\n \"value\": \"Roy\",\n \"variable\": \"firstname\"\n }\n ],\n \"start\": \"true\",\n \"periodMs\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v4/campaign/:campaignId/batch/:batchId","host":["{{url}}"],"path":["v4","campaign",":campaignId","batch",":batchId"],"variable":[{"key":"campaignId","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","description":"Id of the campaign"},{"key":"batchId","value":"b2904860-59cd-11eb-b685-d322c09b20ac","description":"Id of the batch"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"293","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"campaignId\": \"24926fc0-59c8-11eb-a850-5d6f7436c35b\",\n \"batchId\": \"b2904860-59cd-11eb-b685-d322c09b20ac\",\n \"displayName\": \"My runner edited\",\n \"status\": \"Not started\",\n \"started\": 0,\n \"queued\": 1,\n \"periodMs\": 0\n }\n ]\n}"}],"_postman_id":"7775cd3b-21ad-4d9b-b39c-bff6d9e9801d"},{"name":"Get Campaign Runners","id":"5d46f047-9c2e-4350-9b13-f738a03bbbe2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/campaign/batch","description":"

Retrieves the status of all campaign runners.

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/campaign/:campaignId/batch","description":"

Retrieves the status of all campaign runners for a particular campaign.

The campaignId to list runners for

\n","type":"text/plain"},"type":"any","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","key":"campaignId"}]}},"response":[{"id":"6d1cdcbc-a2b4-44b0-87f6-3b57b48faabd","name":"Get Campaign Runners for Campaign","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/campaign/:campaignId/batch","host":["{{url}}"],"path":["v4","campaign",":campaignId","batch"],"variable":[{"key":"campaignId","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","description":"The campaignId to list runners for"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"293","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"campaignId\": \"24926fc0-59c8-11eb-a850-5d6f7436c35b\",\n \"batchId\": \"b2904860-59cd-11eb-b685-d322c09b20ac\",\n \"displayName\": \"My runner edited\",\n \"status\": \"Not started\",\n \"started\": 0,\n \"queued\": 1,\n \"periodMs\": 0\n }\n ]\n}"}],"_postman_id":"2fc6baa2-b978-478d-8ebe-5af558ac8e98"},{"name":"Get Campaign Runner","id":"dd527d50-1fb7-49eb-aaf6-fdf3e22c2290","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/campaign/:campaignId/batch/:batchId","description":"

Retrieves the status of a campaign runner for a particular campaign by batchId.

Id of the campaign

\n","type":"text/plain"},"type":"any","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","key":"campaignId"},{"id":"f8da1ea6-ac67-4433-99f1-6bbd111f780d","description":{"content":"

Id of the batch

\n","type":"text/plain"},"type":"any","value":"b2904860-59cd-11eb-b685-d322c09b20ac","key":"batchId"}]}},"response":[{"id":"2f26e880-ae44-41a1-9b34-a75a85165f34","name":"Sample Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"url":{"raw":"{{url}}/v4/campaign/:campaignId/batch/:batchId","host":["{{url}}"],"path":["v4","campaign",":campaignId","batch",":batchId"],"variable":[{"key":"campaignId","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","description":"Id of the campaign"},{"key":"batchId","value":"b2904860-59cd-11eb-b685-d322c09b20ac","description":"Id of the batch"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"293","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"campaignId\": \"24926fc0-59c8-11eb-a850-5d6f7436c35b\",\n \"batchId\": \"b2904860-59cd-11eb-b685-d322c09b20ac\",\n \"displayName\": \"My runner edited\",\n \"status\": \"Not started\",\n \"started\": 0,\n \"queued\": 1,\n \"periodMs\": 0\n }\n ]\n}"}],"_postman_id":"dd527d50-1fb7-49eb-aaf6-fdf3e22c2290"},{"name":"Start a Campaign Runner","id":"5c5b58c1-1ae4-4cac-abbd-4a76e0563754","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/campaign/:campaignId/batch/:batchId/start","description":"

Starts the campaign runner for a particular campaign by batchId.

Id of the campaign

\n","type":"text/plain"},"type":"any","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","key":"campaignId"},{"id":"1a6f4d17-5922-483a-b368-3f8030210c25","description":{"content":"

Id of the batch

\n","type":"text/plain"},"type":"any","value":"b2904860-59cd-11eb-b685-d322c09b20ac","key":"batchId"}]}},"response":[{"id":"49b10c10-0044-497c-a1dc-16b9522c89cb","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v4/campaign/:campaignId/batch/:batchId/start","host":["{{url}}"],"path":["v4","campaign",":campaignId","batch",":batchId","start"],"variable":[{"key":"campaignId","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","description":"Id of the campaign"},{"key":"batchId","value":"b2904860-59cd-11eb-b685-d322c09b20ac","description":"Id of the batch"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"293","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"campaignId\": \"24926fc0-59c8-11eb-a850-5d6f7436c35b\",\n \"batchId\": \"b2904860-59cd-11eb-b685-d322c09b20ac\",\n \"displayName\": \"My runner edited\",\n \"status\": \"Not started\",\n \"started\": 0,\n \"queued\": 1,\n \"periodMs\": 0\n }\n ]\n}"}],"_postman_id":"5c5b58c1-1ae4-4cac-abbd-4a76e0563754"},{"name":"Stop a Campaign Runner","id":"35c29f57-1024-417b-85a1-9d8cd603fa83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/campaign/:campaignId/batch/:batchId/stop","description":"

Stops the campaign runner for a particular campaign by batchId.

Id of the campaign

\n","type":"text/plain"},"type":"any","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","key":"campaignId"},{"id":"0db587c6-1820-4e98-8299-b5c49da7ac67","description":{"content":"

Id of the batch

\n","type":"text/plain"},"type":"any","value":"b2904860-59cd-11eb-b685-d322c09b20ac","key":"batchId"}]}},"response":[{"id":"e315968d-0073-48a1-af8a-467fa54f943e","name":"Sample Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"Generated using the v4 Authentication endpoint.","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/v4/campaign/:campaignId/batch/:batchId/stop","host":["{{url}}"],"path":["v4","campaign",":campaignId","batch",":batchId","stop"],"variable":[{"key":"campaignId","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","description":"Id of the campaign"},{"key":"batchId","value":"b2904860-59cd-11eb-b685-d322c09b20ac","description":"Id of the batch"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"289","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Vary","value":"Access-Control-Request-Method","enabled":true},{"key":"Vary","value":"Access-Control-Request-Headers","enabled":true},{"key":"Access-Control-Allow-Credentials","value":"true","enabled":true},{"key":"X-RateLimit-Remaining-second","value":"149","enabled":true},{"key":"X-RateLimit-Limit-second","value":"150","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"count\": 1,\n \"page\": 1,\n \"payload\": [\n {\n \"accountSid\": \"173c6f7f-c911-f823-fb2d-a13e4780c300\",\n \"campaignId\": \"24926fc0-59c8-11eb-a850-5d6f7436c35b\",\n \"batchId\": \"b2904860-59cd-11eb-b685-d322c09b20ac\",\n \"displayName\": \"My runner edited\",\n \"status\": \"Stopped\",\n \"started\": 0,\n \"queued\": 1,\n \"periodMs\": 0\n }\n ]\n}"}],"_postman_id":"35c29f57-1024-417b-85a1-9d8cd603fa83"},{"name":"Get next Campaign Runner (Manual)","id":"2a649f94-7c1d-4e1e-ae58-01bccd996da4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/campaign/:campaignId/batch/:batchId/next/","description":"

Gets the next queued contact within a queue. This will not start a campaign workflow.

This is only available for campaigns with a 0 periodMs.

Id of the campaign

\n","type":"text/plain"},"type":"any","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","key":"campaignId"},{"id":"30d53f7c-5896-4225-8e5d-4e3e24f85e9a","description":{"content":"

Id of the batch

\n","type":"text/plain"},"type":"any","value":"b2904860-59cd-11eb-b685-d322c09b20ac","key":"batchId"}]}},"response":[],"_postman_id":"2a649f94-7c1d-4e1e-ae58-01bccd996da4"},{"name":"Send next Campaign Runner (Manual)","id":"4e6e27d0-35d5-462b-872b-90fc36d1379c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n","type":"text"}],"url":"{{url}}/v4/campaign/:campaignId/batch/:batchId/next","description":"

Sends the next queued contact within a queue.

This is only available for campaigns with a 0 periodMs.

Id of the campaign

\n","type":"text/plain"},"type":"any","value":"24926fc0-59c8-11eb-a850-5d6f7436c35b","key":"campaignId"},{"id":"50d089c3-7440-45bc-816f-f9a59e9d91ac","description":{"content":"

Id of the batch

\n","type":"text/plain"},"type":"any","value":"b2904860-59cd-11eb-b685-d322c09b20ac","key":"batchId"}]}},"response":[],"_postman_id":"4e6e27d0-35d5-462b-872b-90fc36d1379c"}],"id":"ac158684-da70-4e99-8eee-f95bcd857a76","description":"

The workflow runner endpoints support the automated sending of workflows to a list of contacts created either through a provided list or a contact query. The details of the requests to setup and edit are detailed in the relevant section.

All of these endpoints will return back the status of the runner(s).

Returned variables:

accountSid: Account id
campaignId: Id of the campaign that the runner is for
batchId: Unique identifier for this particular runner
displayName: Friendly name for the batch used only in the UI
status: Current status of the runner. Possible values: Stopped, Not started, In Progress, and Completed.
started: Number of contacts that have started in the workflow.
queued: Total number of contacts that were selected for the workflow.
periodMs: Scheduled delay between contacts. This rate is the target rate to deliver contacts to start a workflow.

periodMs: Scheduled delay between contacts. This rate is the target rate to deliver contacts to start a workflow. Auto rate-limiting can be use by passing -1.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"421f9a63-a359-4c71-8020-56cb2e982e9f"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"65395f9a-e77d-4992-ad28-296c340f3366"}}],"_postman_id":"ac158684-da70-4e99-8eee-f95bcd857a76","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Work groups","item":[{"name":"Get Work Groups","id":"dd6f2aa6-0dc6-44b6-b0f7-29ae5b972cb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint

\n"}],"url":"https://api.ytel.com/ams/v3/workgroup","description":"

Retrieve all work groups.

Generated using the v4 Authentication endpoint

\n"}],"url":"https://api.ytel.com/ams/v3/workgroup/:groupname","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"protocol":"https","path":["ams","v3","workgroup",":groupname"],"host":["api","ytel","com"],"query":[],"variable":[{"id":"3f76fb61-1c4a-4db9-a06e-042120220cd8","description":{"content":"

The group name of the work group.

\n","type":"text/plain"},"type":"any","value":"crew","key":"groupname"}]}},"response":[],"_postman_id":"cc55dfe2-b420-4493-bedf-290174209419"},{"name":"Create Work Group","id":"8f942083-0705-4d8f-97e1-85b2694557c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint

\n"}],"body":{"mode":"raw","raw":"{\n \"groupName\": \"crew\", \n \"description\": \"The Crew\",\n \"metadata\": {\"accountItem\":\"KRTC\", \"region\":\"Northeast\"},\n \"details\": {\"manager\": \"Jane\"}, \n \"userIds\": [\"07f9bc1a-7777-4444-8888-0601e38803ca\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/workgroup","description":"

Create work group.

Generated using the v4 Authentication endpoint

\n"}],"body":{"mode":"raw","raw":"{\n \"groupName\": \"crew\", \n \"description\": \"The Crew\",\n \"metadata\": {\"accountItem\":\"KRTC\", \"region\":\"Northeast\"},\n \"details\": {\"manager\": \"Jane\"}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/workgroup","description":"

Modify a work group's description, metadata, or details.

Generated using the v4 Authentication endpoint

\n"}],"url":"https://api.ytel.com/ams/v3/workgroup/:groupname","description":"

Delete the selected work group.

Generated using the v4 Authentication endpoint

\n"}],"body":{"mode":"raw","raw":"{\n \"groupName\": \"crew\", \n \"userIds\": [\"07f9bc1a-7777-4444-8888-0601e38803ca\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ytel.com/ams/v3/workgroup","description":"

Add user Ids to an existing work group.

Generated using the v4 Authentication endpoint

Remove user Ids from an existing work group.

Retrieves all voicemails in the system that are between the start and end date with an optional status. Default start and end dates will correspond to the previous 14 days.

Must have the number read permission to access this endpoint.

Retrieves all voicemails for a phone number.

Must have either the number read permission or be the user assigned to that webrtc phone number.

Retrieve a voicemail by phone number and recordId.

Must have either the number read permission or be the user assigned to that webrtc phone number.

Updates the status of a voicemail. Set to 1 to mark as listened or -1 to delete.

Must have either the number read permission or be the user assigned to that webrtc phone number.

The voicemail endpoints allow for retrieving information about voicemails in the system and updating the status of a voicemail.

Fields:

accountSid: Account id
phoneNumber: Phone number associated with the voicemail
recordingId: Unique id for the voicemail recording
contactId: The contact associated with the voicemail
fromNumber: Phone number of the contact that left the voicemail.
seconds: Duration of the voicemail. Note that this is not the same as the duration of the associated call since the call time prior to the start of the voicemail is not included.
url: Location of the recording for download or play.
metadata: Metadata associated with the call. Call metadata is included here.
transcription: Transcription of the voicemail if enabled.
status: Status of the voicemail. 0 is new, 1 is a voicemail that has been listened to. Setting the status to -1 will delete the voicemail record.

\n","_postman_id":"d3095cb7-cd38-43f9-be39-1459783e48a6","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}},{"name":"Transfer Presets","item":[{"name":"Create Transfer Preset","id":"eae237f8-ba24-4493-a773-521a57658ddf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"groupId\": \"wg1\",\n \"presetType\": \"workgroup\",\n \"destination\": \"+12223334444\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v4/preset/transfer","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","preset","transfer"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eae237f8-ba24-4493-a773-521a57658ddf"},{"name":"Delete Transfer Preset","id":"5ab0124c-390d-4f60-a4af-11dcd749806a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{url}}/v4/preset/transfer/{groupId}/presetType/{type}/destination/{destination}","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","preset","transfer","{groupId}","presetType","{type}","destination","{destination}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ab0124c-390d-4f60-a4af-11dcd749806a"},{"name":"Get Transfer Presets","id":"676047ae-1039-49bc-a520-9d40a5dcd64e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/preset/transfer","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","preset","transfer"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"676047ae-1039-49bc-a520-9d40a5dcd64e"},{"name":"Get Transfer Preset By Group","id":"ea9a1720-4f49-4b6f-9fa4-57869e65d410","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/v4/preset/transfer/{groupId}","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}},"urlObject":{"path":["v4","preset","transfer","{groupId}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea9a1720-4f49-4b6f-9fa4-57869e65d410"}],"id":"ee5cb948-ace4-4108-b67f-4e0d5548b9f4","description":"

Sometimes you would like to have presets for your users to select from for a transfer in a webphone call. Transfer Presets allows you to do that. These can be created at the 'account', 'workgroup', or 'user' levels. They take identifiers in that same order 'accountSid', 'groupId', or 'clientId'.

\n","_postman_id":"ee5cb948-ace4-4108-b67f-4e0d5548b9f4","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":true,"source":{"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","name":"CPaaS API","type":"folder"}}}],"id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49","description":"

Ytel V4 REST API

The V4 apis are all authenticated using a JWT bearer token that can be obtained by making a request to https://api.ytel.com/auth/v3/token/ (see documentation). The returned token from that call will have two tokens in its payload. The first token accessToken is used for identity verification on all requests to the V4 endpoints. The second token refreshToken is used to get new access tokens. By default an access token is valid for 120 minutes.

The accessToken should be embedded in the Authorization header with a format of Bearer {{accessToken}} where {{accessToken}} is the accessToken.

The general structure of a V4 response will look like:

{\n  \"status\": true,\n  \"count\": 1,\n  \"page\": 1,\n  \"payload\": [],\n  \"error\": []\n}\n\n

status: This will be true or false. If true the payload array will be populated, If false the error array will be populated. Some calls doing bulk operations may return both with a success response.
\n
count: Number of results in the payload.
\n
page: Generally 1. For requests that support paging this will be the page number.
\n
payload: For successful calls this will be a list of JSON objects. Refer to the individual call for the expected payload object.
\n
error: For failed calls this will be a list of error objects. Typically there will only be 1 error.
\n

Example error

{\n  \"code\": \"403\",\n  \"message\": \"Authentication Error\",\n  \"moreInfo\": \"Bad token\"\n}\n\n

code: Error code for the error encountered. In most cases this will be an integer wrapped in a String.
\n
message: Human readable error message describing the failure.
\n
moreInfo: Optional field that has error specific data.
\n

\n","auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"3d38634a-c5de-47f8-a9cb-ff4676859ea5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"62c88606-fb1d-4060-9b87-9ae20d2040f2"}}],"_postman_id":"14e0156b-7eea-46e4-9e90-0fbb78dfde49"},{"name":"CCaaS API","item":[{"name":"Agent API","item":[{"name":"external_hangup","id":"3f0f7cf4-a1ff-4228-94e1-ea5569ab7034","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=external_hangup&user=&pass=&agent_user=&source=&close_window_link=","description":"

sends command to hangup the current phone call for one specific agent(Hangup Customer)

\n","urlObject":{"protocol":"https","path":["x5","api","agent.php"],"host":["YOUR_URL","ytel","com"],"query":[{"description":{"content":"

Required Value: external_hangup

\n","type":"text/plain"},"key":"function","value":"external_hangup"},{"description":{"content":"

is the API user

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

is the ytel agent user whose session that you want to affect

\n","type":"text/plain"},"key":"agent_user","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

will display a link to close the window, useful if you pop up the API link in a browser window

\n","type":"text/plain"},"key":"close_window_link","value":""}],"variable":[]}},"response":[],"_postman_id":"3f0f7cf4-a1ff-4228-94e1-ea5569ab7034"},{"name":"external_status","id":"df424a51-189c-4c63-903b-4475709e3af8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=external_status&user=&pass=&agent_user=&source=&close_window_link=&language=&value=&callback_datetime=&callback_type=&callback_comments=&qm_dispo_code=","description":"

sends command to set the disposition for one specific agent and move on to next call

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"cad6a687-a4d8-4ead-84be-d60f260c9f83","id":"cad6a687-a4d8-4ead-84be-d60f260c9f83","name":"Agent API","type":"folder"}},"urlObject":{"protocol":"https","path":["x5","api","agent.php"],"host":["YOUR_URL","ytel","com"],"query":[{"description":{"content":"

Required Value: external_status

\n","type":"text/plain"},"key":"function","value":"external_status"},{"description":{"content":"

is the API user

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

is the ytel agent user whose session that you want to affect

\n","type":"text/plain"},"key":"agent_user","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

will display a link to close the window, useful if you pop up the API link in a browser window

\n","type":"text/plain"},"key":"close_window_link","value":""},{"description":{"content":"

currently only works for close window link: en=English, es=Spanish

\n","type":"text/plain"},"key":"language","value":""},{"description":{"content":"

Any valid status in the Ytel system will work for this function

\n","type":"text/plain"},"key":"value","value":""},{"description":{"content":"

YYYY-MM-DD+HH:MM:SS, date and time of scheduled callback. REQUIRED if callback is set and status is flagged as a scheduled callback

\n","type":"text/plain"},"key":"callback_datetime","value":""},{"description":{"content":"

USERONLY or ANYONE, default is ANYONE

\n","type":"text/plain"},"key":"callback_type","value":""},{"description":{"content":"

Optional comments to appear when the callback is called back, must be less than 200 characters in length

\n","type":"text/plain"},"key":"callback_comments","value":""},{"description":{"content":"

Option callstatus code used if QM is enabled

\n","type":"text/plain"},"key":"qm_dispo_code","value":""}],"variable":[]}},"response":[],"_postman_id":"df424a51-189c-4c63-903b-4475709e3af8"},{"name":"external_pause","id":"40ce7bfc-729d-4983-b536-29afd0aad2d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=external_pause&user=&pass=&agent_user=&source=&value=","description":"

sends command to pause/resume an agent now if not on a call, or pause after their next call if on call

Required Value: external_pause

\n","type":"text/plain"},"key":"function","value":"external_pause"},{"description":{"content":"

is the API user

\n","type":"text/plain"},"key":"user","value":""},{"key":"pass","value":""},{"key":"agent_user","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

PAUSE: Pauses the agent session\nRESUME: Resumes the agent session

\n","type":"text/plain"},"key":"value","value":""}],"variable":[]}},"response":[],"_postman_id":"40ce7bfc-729d-4983-b536-29afd0aad2d8"},{"name":"external_dial","id":"25dda43e-ef5e-45d6-bf91-f108eaceb41a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=external_dial&user=&pass=&source=&value=&lead_id=&phone_code=&search=&preview=&focus=&vendor_id=&dial_prefix=&group_alias=&alt_user=&alt_dial=","description":"

Places a manual dial phone call on the agent screen, you can define whether to search for the lead in the existing database or not and you can define the phone_code and the number to dial. This action will pause the agent after their current call, enter in the information to place the call, and dialing the call on the agent screen.

Required Value: external_dial

\n","type":"text/plain"},"key":"function","value":"external_dial"},{"description":{"content":"

is the API user

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

Any valid phone number, or \"MANUALNEXT\" to mimic the Dial Next Number button

\n","type":"text/plain"},"key":"value","value":""},{"description":{"content":"

Any valid lead_id from the system either value or lead_id are required if both are defined, lead_id will override value

\n","type":"text/plain"},"key":"lead_id","value":""},{"description":{"content":"

Any valid phone country code 1 for USA

\n","type":"text/plain"},"key":"phone_code","value":""},{"description":{"content":"

YES: perform a search in the campaign-defined ytel_list list for this phone number and bring up that lead\nNO: do not search, create a new ytel_list record for the call

\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"

YES: preview the lead in the ytel screen without dialing\nNO: do not preview the lead, place call immediately

\n","type":"text/plain"},"key":"preview","value":""},{"description":{"content":"

YES: change the focus of the screen to the ytel.php agent interface, brings up an alert in the browser window\nNO: do not change focus

\n","type":"text/plain"},"key":"focus","value":""},{"description":{"content":"

OPTIONAL, any valid Vendor lead code

\n","type":"text/plain"},"key":"vendor_id","value":""},{"description":{"content":"

OPTIONAL, any dial prefix that you want to add to the beginning of the dial string for this call

\n","type":"text/plain"},"key":"dial_prefix","value":""},{"description":{"content":"

OPTIONAL, the outbound callerID(from an existing group-alias) that you want to use for this call

\n","type":"text/plain"},"key":"group_alias","value":""},{"description":{"content":"

OPTIONAL, instead of agent_user, this is to lookup the agent_user using the ytel_users.custom_three field

\n","type":"text/plain"},"key":"alt_user","value":""},{"description":{"content":"

OPTIONAL, if using lead_id you can set this flag to dial the ALT number or the ADDR3 number or SEARCH a phone_number within the lead\nif SEARCH is used and the phone_number is not matched with the lead's phone_number, alt_phone or address3 field an ERROR will be returned

\n","type":"text/plain"},"key":"alt_dial","value":""}],"variable":[]}},"response":[],"_postman_id":"25dda43e-ef5e-45d6-bf91-f108eaceb41a"},{"name":"preview_dial_action","id":"006ac1ed-3ad6-4bfa-874c-37239a7aa19a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=preview_dial_action&user=&pass=&source=&value=&agent_user=","description":"

sends a SKIP, DIALONLY, ALTDIAL, ADR3DIAL or FINISH when a lead is being previewed or manual alt dial

Required Value: preview_dial_action

\n","type":"text/plain"},"key":"function","value":"preview_dial_action"},{"description":{"content":"

is the API user

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

One of the following actions SKIP, DIALONLY, ALTDIAL, ADR3DIAL or FINISH

\n","type":"text/plain"},"key":"value","value":""},{"description":{"content":"

REQUIRED alphanumeric string for active agent user

\n","type":"text/plain"},"key":"agent_user","value":""}],"variable":[]}},"response":[],"_postman_id":"006ac1ed-3ad6-4bfa-874c-37239a7aa19a"},{"name":"external_add_lead","id":"778e91ed-a069-4256-910b-37ba2733bc1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=external_add_lead&user=&pass=&source=&agent_user=&dnc_check=&campaign_dnc_check=&address1=&address2=&address3=&alt_phone=&city=&comments=&country_code=&date_of_birth=&email=&first_name=&gender=&gmt_offset_now=&last_name=&middle_initial=&phone_number=&phone_code=&postal_code=&province=&security_phrase=&source_id=&state=&title=&vendor_lead_code=&rank=&owner=","description":"

Adds a lead in the manual dial list of the campaign for logged-in agent. A much simplified add lead function compared to the Non-Agent API function

Required Value: external_add_lead

\n","type":"text/plain"},"key":"function","value":"external_add_lead"},{"description":{"content":"

is the API user

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call (maximum 20 characters)

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

REQUIRED alphanumeric string for agent user

\n","type":"text/plain"},"key":"agent_user","value":""},{"description":{"content":"

OPTIONAL: Check for number against system DNC

\n","type":"text/plain"},"key":"dnc_check","value":""},{"description":{"content":"

OPTIONAL: Check for number against campaign DNC from the agent's campaign

\n","type":"text/plain"},"key":"campaign_dnc_check","value":""},{"key":"address1","value":""},{"key":"address2","value":""},{"key":"address3","value":""},{"key":"alt_phone","value":""},{"key":"city","value":""},{"key":"comments","value":""},{"key":"country_code","value":""},{"key":"date_of_birth","value":""},{"key":"email","value":""},{"key":"first_name","value":""},{"key":"gender","value":""},{"key":"gmt_offset_now","value":""},{"key":"last_name","value":""},{"key":"middle_initial","value":""},{"key":"phone_number","value":""},{"key":"phone_code","value":""},{"key":"postal_code","value":""},{"key":"province","value":""},{"key":"security_phrase","value":""},{"key":"source_id","value":""},{"key":"state","value":""},{"key":"title","value":""},{"key":"vendor_lead_code","value":""},{"key":"rank","value":""},{"key":"owner","value":""}],"variable":[]}},"response":[],"_postman_id":"778e91ed-a069-4256-910b-37ba2733bc1d"},{"name":"change_ingroups","id":"044e767a-77ee-4bce-a7ad-95843b928718","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=change_ingroups&user=&pass=&source=&value=&blended=&ingroup_choices=&set_as_default=","description":"

changes the selected in-groups for a logged-in agent

Required Value: change_ingroups

\n","type":"text/plain"},"key":"function","value":"change_ingroups"},{"description":{"content":"

is the API user

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call (maximum 20 characters)

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

CHANGE: will change all in-groups to those defined in ingroup_choices\nREMOVE: will only remove the listed in-groups\nADD: will only add the listed in-groups

\n","type":"text/plain"},"key":"value","value":""},{"description":{"content":"

YES: set the agent to take outbound auto-dialed calls not applicable in MANUAL and INBOUND_MAN dial method campaigns\nNO: set the agent to only take inbound calls

\n","type":"text/plain"},"key":"blended","value":""},{"description":{"content":"

OPTIONAL, a space-delimited use plusses + in the URL list of in-groups to allow the agent to take calls from, example: \" TEST_IN2 SALESLINE TRAINING_IN -\"

\n","type":"text/plain"},"key":"ingroup_choices","value":""},{"description":{"content":"

OPTIONAL, YES or NO - overwrites the settings for the agent in the user modification screen, default is NO

\n","type":"text/plain"},"key":"set_as_default","value":""}],"variable":[]}},"response":[],"_postman_id":"044e767a-77ee-4bce-a7ad-95843b928718"},{"name":"update_fields","id":"25e197f0-fe98-467c-a329-8fb1ed5bdaf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=update_fields&user=&pass=&source=&agent_user=&address1=&address2=&address3=&alt_phone=&city=&comments=&country_code=&date_of_birth=&email=&first_name=&gender=&gmt_offset_now=&last_name=&middle_initial=&phone_number=&phone_code=&postal_code=&province=&security_phrase=&source_id=&state=&title=&vendor_lead_code=&rank=&owner=","description":"

changes values for selected data fields in the agent interface

Required Value: update_fields

\n","type":"text/plain"},"key":"function","value":"update_fields"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

API User Password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

REQUIRED alphanumeric string for agent use

\n","type":"text/plain"},"key":"agent_user","value":""},{"key":"address1","value":""},{"key":"address2","value":""},{"key":"address3","value":""},{"key":"alt_phone","value":""},{"key":"city","value":""},{"key":"comments","value":""},{"key":"country_code","value":""},{"key":"date_of_birth","value":""},{"key":"email","value":""},{"key":"first_name","value":""},{"key":"gender","value":""},{"key":"gmt_offset_now","value":""},{"key":"last_name","value":""},{"key":"middle_initial","value":""},{"key":"phone_number","value":""},{"key":"phone_code","value":""},{"key":"postal_code","value":""},{"key":"province","value":""},{"key":"security_phrase","value":""},{"key":"source_id","value":""},{"key":"state","value":""},{"key":"title","value":""},{"key":"vendor_lead_code","value":""},{"key":"rank","value":""},{"key":"owner","value":""}],"variable":[]}},"response":[],"_postman_id":"25e197f0-fe98-467c-a329-8fb1ed5bdaf5"},{"name":"set_timer_action","id":"a7ab1b17-8da7-4c88-9c73-9ecf9f0d727e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=set_timer_action&user=&pass=&source=&agent_user=&value=¬es=&rank=","description":"

Updates the fields that are specified with the values. This will update the data that is on the agent's screen in the customer information section.

Required Value: set_timer_action

\n","type":"text/plain"},"key":"function","value":"set_timer_action"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

REQUIRED, alphanumeric string for agent user

\n","type":"text/plain"},"key":"agent_user","value":""},{"description":{"content":"

REQUIRED, one of these choices: 'NONE','WEBFORM','WEBFORM2','D1_DIAL','D2_DIAL','D3_DIAL','D4_DIAL','D5_DIAL','MESSAGE_ONLY'

\n","type":"text/plain"},"key":"value","value":""},{"description":{"content":"

Optional, the message to be displayed with the timer action

\n","type":"text/plain"},"key":"notes","value":""},{"description":{"content":"

Optional, the number of seconds into the call to display

\n","type":"text/plain"},"key":"rank","value":""}],"variable":[]}},"response":[],"_postman_id":"a7ab1b17-8da7-4c88-9c73-9ecf9f0d727e"},{"name":"st_login_log","id":"0a7b71fe-fa62-419c-8df2-b67f7729073e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=st_login_log&user=&pass=&source=&value=&vendor_id=","description":"

Looks up the ytel_users.custom_three field(as \"agentId\") to associate with a ytel user ID. If found it will populate the custom_four field with a \"teamId\" value, then output the ytel user ID

Required Value: st_login_log

\n","type":"text/plain"},"key":"function","value":"st_login_log"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

REQUIRED alphanumeric string for CRM AgentID

\n","type":"text/plain"},"key":"value","value":""},{"description":{"content":"

REQUIRED alphanumeric string for CRM TeamID

\n","type":"text/plain"},"key":"vendor_id","value":""}],"variable":[]}},"response":[],"_postman_id":"0a7b71fe-fa62-419c-8df2-b67f7729073e"},{"name":"st_get_agent_active_lead","id":"839f3dce-a99b-49f1-be6a-e3efbe8482e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=st_get_agent_active_lead&user=&pass=&source=&value=&vendor_id=","description":"

Looks up the ytel_users.custom_three field(as \"agentId\") to associate with a ytel user ID. If found it will output the active lead_id and phone number, vendor_lead_code, province, security_phrase and source_id fields.

Required Value: st_get_agent_active_lead

\n","type":"text/plain"},"key":"function","value":"st_get_agent_active_lead"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

REQUIRED alphanumeric string for CRM AgentID

\n","type":"text/plain"},"key":"value","value":""},{"description":{"content":"

REQUIRED alphanumeric string for CRM TeamID

\n","type":"text/plain"},"key":"vendor_id","value":""}],"variable":[]}},"response":[],"_postman_id":"839f3dce-a99b-49f1-be6a-e3efbe8482e5"},{"name":"ra_call_control","id":"6aa00570-fb28-43b8-9da6-9cfcebbfbaf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=ra_call_control&user=&pass=&source=&value=&agent_user=&stage=&ingroup_choices=&phone_number=&status=","description":"

Allows for remote agent call control: hangup/transfer calls being handled by remote agents, also options for recording a disposition and call length

Required Value: ra_call_control

\n","type":"text/plain"},"key":"function","value":"ra_call_control"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

REQUIRED, The call ID of the call as received as CallerIDname field or a special SIP-header, i.e. Y0315201639000402027

\n","type":"text/plain"},"key":"value","value":""},{"description":{"content":"

REQUIRED, alphanumeric string for remote agent use

\n","type":"text/plain"},"key":"agent_user","value":""},{"description":{"content":"

REQUIRED, one of these choices: 'HANGUP','EXTENSIONTRANSFER','INGROUPTRANSFER'

\n","type":"text/plain"},"key":"stage","value":""},{"description":{"content":"

OPTIONAL, only required if INGROUPTRANSFER stage is used, must be a single active in-group, reserved option of \"DEFAULTINGROUP\" can be used to send the call to the default in-group for the in-group or campaign that originated the call to the remote agent

\n","type":"text/plain"},"key":"ingroup_choices","value":""},{"description":{"content":"

OPTIONAL, only required if EXTENSIONTRANSFER stage is used, must be a full number when dialed that will dial through the default context

\n","type":"text/plain"},"key":"phone_number","value":""},{"description":{"content":"

OPTIONAL, status of the call, maximum of 6 characters, if not set, status will be RAXFER

\n","type":"text/plain"},"key":"status","value":""}],"variable":[]}},"response":[],"_postman_id":"6aa00570-fb28-43b8-9da6-9cfcebbfbaf2"},{"name":"send_dtmf","id":"a00c560b-d837-4d94-bc53-21eb226da035","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=send_dtmf&user=&pass=&source=&value=&agent_user=","description":"

Sends dtmf signal string to agent's session

Required Value: send_dtmf

\n","type":"text/plain"},"key":"function","value":"send_dtmf"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

only valid DTMF characters with these replacements:\n P = # (pound or hash)\n S = * (star)\n Q = (one second of silence)

\n","type":"text/plain"},"key":"value","value":""},{"key":"agent_user","value":""}],"variable":[]}},"response":[],"_postman_id":"a00c560b-d837-4d94-bc53-21eb226da035"},{"name":"transfer_conference","id":"76d6bdd4-7ce5-426f-bfed-55856091893e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=transfer_conference&user=&pass=&source=&value=&agent_user=&phone_number=&ingroup_choices=&consultative=&dial_override=&group_alias=","description":"

sends several commands related to the agent transfer-conf frame

Required Value: transfer_conference

\n","type":"text/plain"},"key":"function","value":"transfer_conference"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

HANGUP_XFER - hangup the third party line\n HANGUP_BOTH - hangup customer and third party line\n BLIND_TRANSFER - send a call to a defined phone number\n LEAVE_VM - blind transfer customer to the campaign-defined voicemail message\n LOCAL_CLOSER - send call to another ytel agent, must have in-group, optional phone_number field for AGENTDIRECT agent\n DIAL_WITH_CUSTOMER - 3-way call with customer on the line\n PARK_CUSTOMER_DIAL - send customer to park and place a call to a third party\n LEAVE_3WAY_CALL - leave customer and third party in conference and go to the disposition screen

\n","type":"text/plain"},"key":"value","value":""},{"key":"agent_user","value":""},{"description":{"content":"

OPTIONAL/REQUIRED, required for any transfer or dial value

\n","type":"text/plain"},"key":"phone_number","value":""},{"description":{"content":"

OPTIONAL/REQUIRED, required for local_closer and consultative transfers, must be a single active in-group, reserved option of \"DEFAULTINGROUP\" can be used to select the default in-group for the in-group or campaign that the call originated from

\n","type":"text/plain"},"key":"ingroup_choices","value":""},{"description":{"content":"

OPTIONAL, when you want to do a consultative transfer with your customer and another ytel agent, 'YES' and 'NO' are valid options, you can only use this with DIAL_WITH_CUSTOMER or PARK_CUSTOMER_DIAL

\n","type":"text/plain"},"key":"consultative","value":""},{"description":{"content":"

OPTIONAL, dials exactly the phone number specified with no campaign-defined phone code or prefix

\n","type":"text/plain"},"key":"dial_override","value":""},{"description":{"content":"

OPTIONAL, defines what caller ID number to use when doing DIAL_WITH_CUSTOMER or PARK_CUSTOMER_DIAL

\n","type":"text/plain"},"key":"group_alias","value":""}],"variable":[]}},"response":[],"_postman_id":"76d6bdd4-7ce5-426f-bfed-55856091893e"},{"name":"park_call","id":"1ea5137e-e567-4f74-a3cc-9dda60471828","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=park_call&user=&pass=&source=&agent_user=&value=","description":"

sends command to park customer or grab customer from park or ivr

Required Value: park_call

\n","type":"text/plain"},"key":"function","value":"park_call"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"key":"agent_user","value":""},{"description":{"content":"

PARK_CUSTOMER - send customer to the park extension as defined in the campaign the agent is logged into\nGRAB_CUSTOMER - grab customer from the park extension and send them to the agent session\nPARK_IVR_CUSTOMER - send customer to the park ivr as defined in the campaign the agent is logged into, customer will come back after finishing IVR\nGRAB_IVR_CUSTOMER - grab customer from the park ivr and send them to the agent session

\n","type":"text/plain"},"key":"value","value":""}],"variable":[]}},"response":[],"_postman_id":"1ea5137e-e567-4f74-a3cc-9dda60471828"},{"name":"logout","id":"f291213a-21c6-41c8-9a35-2cd18c8d7883","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=logout&user=&pass=&source=&value=logout&agent_user=","description":"

Logs the agent out of the agent interface. If the agent is on a live call, will logout after the live call is dispositioned

Required Value: logout

\n","type":"text/plain"},"key":"function","value":"logout"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

Logout the agent session

\n","type":"text/plain"},"key":"value","value":"logout"},{"description":{"content":"

Agent ID to log out

\n","type":"text/plain"},"key":"agent_user","value":""}],"variable":[]}},"response":[],"_postman_id":"f291213a-21c6-41c8-9a35-2cd18c8d7883"},{"name":"recording","id":"5950202c-1e86-4790-a3c6-82c82c93e498","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=recording&user=&pass=&source=&value=&stage=&agent_user=","description":"

sends a recording start/stop signal or status of agent recording

Required Value: recording

\n","type":"text/plain"},"key":"function","value":"recording"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

START - sends a \"start recording\" signal to the agent screen\n (you can have multiple recordings going at the same time)\n STOP - sends a \"stop recording\" signal to the agent screen\n (this will stop all active recordings onthe agent screen)\n STATUS - displays results of active recording and agent session information\n (returns: user|recording_id|filename|server|start_time|agent_server|session|agent_status)

\n","type":"text/plain"},"key":"value","value":""},{"description":{"content":"

OPTIONAL, value to append to the recording filename, limited to 14 characters, if more it will truncate. Only works with START value

\n","type":"text/plain"},"key":"stage","value":""},{"key":"agent_user","value":""}],"variable":[]}},"response":[],"_postman_id":"5950202c-1e86-4790-a3c6-82c82c93e498"},{"name":"webserver","id":"4dbae70e-ab92-4e93-a337-3d95be1cf378","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?function=webserver&user=&pass=&source=","description":"

display webserver information, very useful for load balanced setups

Required Value: webserver

\n","type":"text/plain"},"key":"function","value":"webserver"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""}],"variable":[]}},"response":[],"_postman_id":"4dbae70e-ab92-4e93-a337-3d95be1cf378"},{"name":"webphone_url","id":"daedfe27-ba6a-48e1-87ea-955ff2587595","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?user=&pass=&source=&function=webphone_url&value=&agent_user=","description":"

display the webphone url for the current agent's session

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

Required Value: webphone_url

\n","type":"text/plain"},"key":"function","value":"webphone_url"},{"description":{"content":"

REQUIRED, choices are below:\n DISPLAY - displays only the URL for the webphone if enabled\n LAUNCH - redirects the url to the webphone url to launch it

\n","type":"text/plain"},"key":"value","value":""},{"key":"agent_user","value":""}],"variable":[]}},"response":[],"_postman_id":"daedfe27-ba6a-48e1-87ea-955ff2587595"},{"name":"call_agent","id":"872e2202-2acc-4f76-8a59-bfe2522be069","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?user=&pass=&source=&function=call_agent&value=&agent_user=","description":"

send a call to connect the agent to their session

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

Required Value: call_agent

\n","type":"text/plain"},"key":"function","value":"call_agent"},{"description":{"content":"

REQUIRED, choices are below:\n CALL - places call from the agent session to the agent's phone

\n","type":"text/plain"},"key":"value","value":""},{"key":"agent_user","value":""}],"variable":[]}},"response":[],"_postman_id":"872e2202-2acc-4f76-8a59-bfe2522be069"},{"name":"pause_code","id":"9d50ee04-9820-40cd-aed6-392e08faf76a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/agent.php?user=&pass=&source=&function=pause_code&value=&agent_user=","description":"

set a pause code if the agent is paused

API User ID

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

is the API user password

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

Required Value: pause_code

\n","type":"text/plain"},"key":"function","value":"pause_code"},{"description":{"content":"

pause code to set, must be 6 characters or less

\n","type":"text/plain"},"key":"value","value":""},{"key":"agent_user","value":""}],"variable":[]}},"response":[],"_postman_id":"9d50ee04-9820-40cd-aed6-392e08faf76a"}],"id":"cad6a687-a4d8-4ead-84be-d60f260c9f83","description":"

The Agent API is a collection of API calls that can be used to interact with Ytel's Contact Center System. More specifically the Agent API's let you interact and modify a specific Agent's Interface in real-time. In order to use the API's you must first create an API user within your Admin interface. Please Contact Ytel Support at 800-382-4913 for assistance with creating an API user.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f26a73c7-5914-49da-b179-8fb61756ba72"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"2746c807-7402-481f-bdfc-f5481c9c6e66"}}],"_postman_id":"cad6a687-a4d8-4ead-84be-d60f260c9f83"},{"name":"Non-Agent API","item":[{"name":"vm_list","id":"cc7b979a-e539-4fb4-903c-2ccac9dfd9eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=vm_list&user=101&pass=123Password&source=postman&format=&comments=","description":"

outputs a list of voicemail boxes in the system

Required Value: vm_list

\n","type":"text/plain"},"key":"function","value":"vm_list"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"},{"description":{"content":"

format of the output(tab, link, selectframe)

\n","type":"text/plain"},"key":"format","value":""},{"description":{"content":"

name of the field to populate

\n","type":"text/plain"},"key":"comments","value":""}],"variable":[]}},"response":[],"_postman_id":"cc7b979a-e539-4fb4-903c-2ccac9dfd9eb"},{"name":"blind_monitor","id":"d1d233c4-9a46-4def-b7d7-ca4c7be98c51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=blind_monitor&user=101&pass=123Password&source=postman&phone_login=&session_id=&server_ip=&stage=","description":"

calls user-defined phone and places them in session as blind monitor

Required Value: blind_monitor

\n","type":"text/plain"},"key":"function","value":"blind_monitor"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"},{"description":{"content":"

alpha-numeric, no spaces or special characters allowed

\n","type":"text/plain"},"key":"phone_login","value":""},{"description":{"content":"

must be all numbers, 7 digits

\n","type":"text/plain"},"key":"session_id","value":""},{"description":{"content":"

must be all numbers and dots, max 15 characters

\n","type":"text/plain"},"key":"server_ip","value":""},{"description":{"content":"

MONITOR or BARGE default is MONITOR

\n","type":"text/plain"},"key":"stage","value":""}],"variable":[]}},"response":[],"_postman_id":"d1d233c4-9a46-4def-b7d7-ca4c7be98c51"},{"name":"agent_ingroup_info","id":"28465e69-4c5f-4eb6-b60c-e1b6287aa610","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=agent_ingroup_info&user=101&pass=123Password&source=postman&stage=&agent_user=","description":"

shows in-group and outbound auto-dial info for logged-in agent

Required Value: agent_ingroup_info

\n","type":"text/plain"},"key":"function","value":"agent_ingroup_info"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"},{"description":{"content":"

info(show information only), change(show options to change), text(standard non-HTML output)

\n","type":"text/plain"},"key":"stage","value":""},{"description":{"content":"

2-20 characters

\n","type":"text/plain"},"key":"agent_user","value":""}],"variable":[]}},"response":[],"_postman_id":"28465e69-4c5f-4eb6-b60c-e1b6287aa610"},{"name":"recording_lookup","id":"764fe033-7d33-4c91-a4f3-3532aee4aab1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=recording_lookup&user=101&pass=123Password&source=postman&agent_user=&lead_id=&date=&uniqueid=&stage=&header=","description":"

looks up recordings based upon user and date or lead_id. There is a hard limit of 100000 results

Required Value: recording_lookup

\n","type":"text/plain"},"key":"function","value":"recording_lookup"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"},{"description":{"content":"

2-20 characters

\n","type":"text/plain"},"key":"agent_user","value":""},{"description":{"content":"

1-10 digits

\n","type":"text/plain"},"key":"lead_id","value":""},{"description":{"content":"

date of the calls to pull (must be in YYYY-MM-DD format)

\n","type":"text/plain"},"key":"date","value":""},{"description":{"content":"

uniqueid of the call, works best included with another search field

\n","type":"text/plain"},"key":"uniqueid","value":""},{"description":{"content":"

the format of the exported data: csv, tab, pipe(default)

\n","type":"text/plain"},"key":"stage","value":""},{"description":{"content":"

include a header(YES) or not(NO). This is optional, default is not to include a header

\n","type":"text/plain"},"key":"header","value":""}],"variable":[]}},"response":[],"_postman_id":"764fe033-7d33-4c91-a4f3-3532aee4aab1"},{"name":"did_log_export","id":"12522979-ecc2-4e2c-8e46-6aecae29a185","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=did_log_export&user=101&pass=123Password&source=postman&phone_number=&date=&stage=&header=","description":"

exports all calls inbound to a DID for one day. There is a hard limit of 100000 results

Required Value: did_log_export

\n","type":"text/plain"},"key":"function","value":"did_log_export"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"},{"description":{"content":"

2-20 characters, the DID that you want to pull logs for

\n","type":"text/plain"},"key":"phone_number","value":""},{"description":{"content":"

date of the calls to pull (must be in YYYY-MM-DD format)

\n","type":"text/plain"},"key":"date","value":""},{"description":{"content":"

the format of the exported data: csv, tab, pipe(default)

\n","type":"text/plain"},"key":"stage","value":""},{"description":{"content":"

include a header(YES) or not(NO). This is optional, default is not to include a header

\n","type":"text/plain"},"key":"header","value":""}],"variable":[]}},"response":[],"_postman_id":"12522979-ecc2-4e2c-8e46-6aecae29a185"},{"name":"agent_stats_export","id":"c0e8e16e-ed41-45cf-90e1-e46cdfc1855f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=agent_stats_export&user=101&pass=123Password&source=postman&datetime_start=&datetime_end=&agent_user=&stage=&header=&time_format=","description":"

exports agent statistics for set time period. There is a hard limit of 10000000 records analyzed

Required Value: agent_stats_export

\n","type":"text/plain"},"key":"function","value":"agent_stats_export"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"},{"description":{"content":"

start date/time of the agent activity to pull (must be in \"YYYY-MM-DD+HH:MM:SS\" format)

\n","type":"text/plain"},"key":"datetime_start","value":""},{"description":{"content":"

end date/time of the agent activity to pull (must be in \"YYYY-MM-DD+HH:MM:SS\" format)

\n","type":"text/plain"},"key":"datetime_end","value":""},{"description":{"content":"

2-20 characters, use only for one agent stats

\n","type":"text/plain"},"key":"agent_user","value":""},{"description":{"content":"

the format of the exported data: csv, tab, pipe(default)

\n","type":"text/plain"},"key":"stage","value":""},{"description":{"content":"

include a header(YES) or not(NO). This is optional, default is not to include a header

\n","type":"text/plain"},"key":"header","value":""},{"description":{"content":"

time format('H','HF','M','S') in hours, minutes or seconds: H = 1:23:45, M = 83:45, S = 5023 (default 'HF')\n * HF will force hour format even for zero seconds time \"0:00:00\"

\n","type":"text/plain"},"key":"time_format","value":""}],"variable":[]}},"response":[],"_postman_id":"c0e8e16e-ed41-45cf-90e1-e46cdfc1855f"},{"name":"add_lead","id":"5e9930d1-07e3-4ec5-bdb9-44cfe027ed98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=add_lead&user=101&pass=123Password&source=postman&phone_number=&phone_code=&list_id=&dnc_check=&campaign_dnc_check=&campaign_id=&add_to_hopper=&hopper_priority=&duplicate_check=&usacan_prefix_check=&usacan_areacode_check=&custom_fields=&tz_method=&callback=&callback_status=&callback_datetime=&callback_type=&callback_user=&callback_comments=&vendor_lead_code=&source_id=&gmt_offset_now=&title=&first_name=&middle_initial=&last_name=&address1=&address2=&address3=&city=&state=&province=&postal_code=&country_code=&gender=&date_of_birth=&alt_phone=&email=&security_phrase=&comments=&multi_alt_phones=&rank=&owner=","description":"

adds a new lead to the ytel list table with several fields and options

Required Value: add_lead

\n","type":"text/plain"},"key":"function","value":"add_lead"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"},{"description":{"content":"

Must be all numbers, 6-16 digits (USA - North America 10 Digits Only)

\n","type":"text/plain"},"key":"phone_number","value":""},{"description":{"content":"

must be all numbers, 1-4 digits, defaults to 1 if not set

\n","type":"text/plain"},"key":"phone_code","value":""},{"description":{"content":"

must be all numbers, 3-12 digits, defaults to 999 if not set

\n","type":"text/plain"},"key":"list_id","value":""},{"description":{"content":"

Y, N or AREACODE, default is N

\n","type":"text/plain"},"key":"dnc_check","value":""},{"description":{"content":"

Y, N or AREACODE, default is N

\n","type":"text/plain"},"key":"campaign_dnc_check","value":""},{"description":{"content":"

2-8 Character campaign ID, required if using campaign_dnc_check or callbacks

\n","type":"text/plain"},"key":"campaign_id","value":""},{"description":{"content":"

Y or N, default is N

\n","type":"text/plain"},"key":"add_to_hopper","value":""},{"description":{"content":"

99 to -99, the higher number the higher priority, default is 0

\n","type":"text/plain"},"key":"hopper_priority","value":""},{"description":{"content":"

Check for duplicate records in the system, can select more than one (duplicate_check=DUPLIST-DUPTITLEALTPHONELIST)\n If duplicate is found, will return error, the duplicate data and lead_id and list_id of existing record\n Here are the duplicate_check options:\n DUPLIST - check for duplicate phone_number in same list\n DUPCAMP - check for duplicate phone_number in all lists for this list's campaign\n DUPSYS - check for duplicate phone_number in entire system\n DUPTITLEALTPHONELIST - check for duplicate title and alt_phone in same list\n DUPTITLEALTPHONECAMP - check for duplicate title and alt_phone in all lists for this list's campaign\n DUPTITLEALTPHONESYS - check for duplicate title and alt_phone in entire system\n DUPNAMEPHONELIST - check for duplicate first_name, last_name and phone_number in same list\n DUPNAMEPHONECAMP - check for duplicate first_name, last_name and phone_number in all lists for this list's campaign\n DUPNAMEPHONESYS - check for duplicate first_name, last_name and phone_number in entire system

\n","type":"text/plain"},"key":"duplicate_check","value":""},{"description":{"content":"

Y or N, default is N. Check for a valid 4th digit for USA and Canada phone numbers (cannot be 0 or 1)

\n","type":"text/plain"},"key":"usacan_prefix_check","value":""},{"description":{"content":"

Y or N, default is N. Check for a valid areacode for USA and Canada phone numbers

\n","type":"text/plain"},"key":"usacan_areacode_check","value":""},{"description":{"content":"

Y or N, default is N. Defines whether the API will accept custom field data when inserting leads into the ytel list table\n For custom fields to be inserted, just add the field label as a variable to the URL string\n For example, if the field_label is \"favorite_color\" you would add \"&favorite_color=blue\"

\n","type":"text/plain"},"key":"custom_fields","value":""},{"description":{"content":"

, POSTAL or TZCODE, default is which will use the country code and areacode for time zone lookups\n POSTAL relies on the postal_code field\n TZCODE relies on the owner field being populated with a proper time zone code

\n","type":"text/plain"},"key":"tz_method","value":""},{"description":{"content":"

Y or N, default is N. Set this lead as a scheduled callback. campaign_id field is REQUIRED for callbacks

\n","type":"text/plain"},"key":"callback","value":""},{"description":{"content":"

1-6 Character, callback status to use, default is CALLBK (ytel list status will be set to CBHOLD to lock)

\n","type":"text/plain"},"key":"callback_status","value":""},{"description":{"content":"

YYYY-MM-DD+HH:MM:SS, date and time of scheduled callback. REQUIRED if callback is set. NOW can be used for current datetime.

\n","type":"text/plain"},"key":"callback_datetime","value":""},{"description":{"content":"

USERONLY or ANYONE, default is ANYONE

\n","type":"text/plain"},"key":"callback_type","value":""},{"description":{"content":"

User ID the USERONLY callback is assigned to

\n","type":"text/plain"},"key":"callback_user","value":""},{"description":{"content":"

Optional comments to appear when the callback is called back

\n","type":"text/plain"},"key":"callback_comments","value":""},{"description":{"content":"

1-20 characters

\n","type":"text/plain"},"key":"vendor_lead_code","value":""},{"description":{"content":"

1-50 characters

\n","type":"text/plain"},"key":"source_id","value":""},{"description":{"content":"

overridden by auto-lookup of phone_code and area_code portion of phone number if applicable

\n","type":"text/plain"},"key":"gmt_offset_now","value":""},{"description":{"content":"

1-10 characters

\n","type":"text/plain"},"key":"title","value":""},{"description":{"content":"

1-30 characters

\n","type":"text/plain"},"key":"first_name","value":""},{"description":{"content":"

1 character

\n","type":"text/plain"},"key":"middle_initial","value":""},{"description":{"content":"

1-30 characters

\n","type":"text/plain"},"key":"last_name","value":""},{"description":{"content":"

1-100 characters

\n","type":"text/plain"},"key":"address1","value":""},{"description":{"content":"

1-100 characters

\n","type":"text/plain"},"key":"address2","value":""},{"description":{"content":"

1-100 characters

\n","type":"text/plain"},"key":"address3","value":""},{"description":{"content":"

1-50 characters

\n","type":"text/plain"},"key":"city","value":""},{"description":{"content":"

2 characters

\n","type":"text/plain"},"key":"state","value":""},{"description":{"content":"

1-50 characters

\n","type":"text/plain"},"key":"province","value":""},{"description":{"content":"

1-10 characters

\n","type":"text/plain"},"key":"postal_code","value":""},{"description":{"content":"

3 characters

\n","type":"text/plain"},"key":"country_code","value":""},{"description":{"content":"

U, M, F (Undefined, Male, Female) - defaults to 'U'

\n","type":"text/plain"},"key":"gender","value":""},{"description":{"content":"

YYYY-MM-DD

\n","type":"text/plain"},"key":"date_of_birth","value":""},{"description":{"content":"

1-12 characters

\n","type":"text/plain"},"key":"alt_phone","value":""},{"description":{"content":"

1-70 characters

\n","type":"text/plain"},"key":"email","value":""},{"description":{"content":"

1-100 characters

\n","type":"text/plain"},"key":"security_phrase","value":""},{"description":{"content":"

1-255 characters

\n","type":"text/plain"},"key":"comments","value":""},{"description":{"content":"

5-1024 characters (see examples for more info)\nMulti-ALT-Phones format:\n7275551212_1_work!7275551213_1_sister+house!1234567890_1_neighbor

\n","type":"text/plain"},"key":"multi_alt_phones","value":""},{"description":{"content":"

1-5 digits

\n","type":"text/plain"},"key":"rank","value":""},{"description":{"content":"

1-20 characters (user ID, Territory or user group)

\n","type":"text/plain"},"key":"owner","value":""}],"variable":[]}},"response":[],"_postman_id":"5e9930d1-07e3-4ec5-bdb9-44cfe027ed98"},{"name":"update_lead","id":"fb9c2d03-6ac9-45cd-9838-c4c712a41a45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=update_lead&user=101&pass=123Password&source=postman&lead_id=&vendor_lead_code=&phone_number=&search_method=&search_location=&insert_if_not_found=&records=&custom_fields=&no_update=&delete_lead=&reset_lead=&callback=&callback_status=&callback_datetime=&callback_type=&callback_user=&callback_comments=&ADDTODNC=&campaign_id=&add_to_hopper=&hopper_priority=&hopper_local_call_time_check=&user_field=&list_id_field=&status=&vendor_lead_code=&source_id=&gmt_offset_now=&title=&first_name=&middle_initial=&last_name=&address1=&address2=&address3=&city=&state=&province=&postal_code=&country_code=&gender=&date_of_birth=&alt_phone=&email=&security_phrase=&comments=&rank=&owner=&called_count=&custom_override=&from_ytel_api=&updateNumber=&addToFilterPhoneGroup=&filter_phone_group_id=","description":"

updates lead information in ytel list and associated custom table.

NOTES:

in order to set a field to empty('') set it equal to --BLANK--, i.e. \"&province=--BLANK--\"
please use no special characters like apostrophes, quotes or amphersands

Required Value: update_lead

\n","type":"text/plain"},"key":"function","value":"update_lead"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"},{"description":{"content":"

must be all numbers, 1-9 digits, not required if using vendor_lead_code or phone_number

\n","type":"text/plain"},"key":"lead_id","value":""},{"description":{"content":"

can be used instead of lead_id to match leads

\n","type":"text/plain"},"key":"vendor_lead_code","value":""},{"description":{"content":"

can be used instead of lead_id or vendor_lead_code to match leads

\n","type":"text/plain"},"key":"phone_number","value":""},{"description":{"content":"

You can combine the following 3 options in this field to search the parameters you desire:\n LEAD_ID, will attempt to find a match with the lead_id\n VENDOR_LEAD_CODE, will attempt to find a match with the vendor_lead_code\n PHONE_NUMBER, will attempt to find a match with the phone_number\n For example to search lead_id and vendor_lead_code: \"&search_method=LEAD_ID_VENDOR_LEAD_CODE\"\n The search order is NOT preserved, Lead ID is always first, Vendor Lead Code is second\n and Phone number is last. Default is \"LEAD_ID\"

\n","type":"text/plain"},"key":"search_method","value":""},{"description":{"content":"

Where to check for records in the system, can select only one(default is SYSTEM):\n LIST - check for lead in same list\n CAMPAIGN - check for lead in all lists for this list's campaign\n SYSTEM - check for lead in entire system\n If no list_id is defined, the the search_location will be assumed as SYSTEM

\n","type":"text/plain"},"key":"search_location","value":""},{"description":{"content":"

Y or N, will attempt to insert as a NEW lead if no match is found, default is N.\n Insertion will require phone_code, phone_number and list_id. lead_id will be ignored.\n Most of the add_lead options that are not available if you use this setting in this function

\n","type":"text/plain"},"key":"insert_if_not_found","value":""},{"description":{"content":"

number of records to update if more than 1 found (defaults to '1'[most recently loaded lead])

\n","type":"text/plain"},"key":"records","value":""},{"description":{"content":"

Y or N, default is N. Defines whether the API will accept custom field data when updating leads in the ytel list table\n For custom fields to be updated, just add the field label as a variable to the URL string\n For example, if the field_label is \"favorite_color\" you would add \"&favorite_color=blue\"

\n","type":"text/plain"},"key":"custom_fields","value":""},{"description":{"content":"

Y or N, Setting this to Y will not perform any updates, but will instead only tell you if a lead exists that matches the search criteria, default is N.

\n","type":"text/plain"},"key":"no_update","value":""},{"description":{"content":"

Y or N, Setting this to Y will delete the lead from the ytel list table, default is N.

\n","type":"text/plain"},"key":"delete_lead","value":""},{"description":{"content":"

Y or N, Setting this to Y will reset the called-since-last-reset flag of the lead, default is N.

\n","type":"text/plain"},"key":"reset_lead","value":""},{"description":{"content":"

Y, N or REMOVE, default is N. Set this lead as a scheduled callback. REMOVE will delete the scheduled callback entry

\n","type":"text/plain"},"key":"callback","value":""},{"description":{"content":"

1-6 Character, callback status to use, default is CALLBK (ytel list status will be set to CBHOLD to lock)

\n","type":"text/plain"},"key":"callback_status","value":""},{"description":{"content":"

YYYY-MM-DD+HH:MM:SS, date and time of scheduled callback. REQUIRED if callback is set. NOW can be used for current datetime.

\n","type":"text/plain"},"key":"callback_datetime","value":""},{"description":{"content":"

USERONLY or ANYONE, default is ANYONE

\n","type":"text/plain"},"key":"callback_type","value":""},{"description":{"content":"

User ID the USERONLY callback is assigned to

\n","type":"text/plain"},"key":"callback_user","value":""},{"description":{"content":"

Optional comments to appear when the callback is called back

\n","type":"text/plain"},"key":"callback_comments","value":""},{"description":{"content":"

This option is required if status=DNC\nBOTH or CAMPAIGN or INTERNAL. Setting this to \"BOTH\" will add the number to both the internal campaign DNC as well as the CAMPIAGN DNC. CAMPAIGN will add the number to only the campaign DNC table. INTERNAL will add the number only to the INTERNAL DNC list.campaignID - Required if Campaign. is selected. This is the campaign ID to add the number to the DNC list.

\n","type":"text/plain"},"key":"ADDTODNC","value":""},{"description":{"content":"

2-8 Character campaign ID, required if using campaign_dnc_check or callbacks

\n","type":"text/plain"},"key":"campaign_id","value":""},{"description":{"content":"

Y or N, default is N

\n","type":"text/plain"},"key":"add_to_hopper","value":""},{"description":{"content":"

99 to -99, the higher number the higher priority, default is 0

\n","type":"text/plain"},"key":"hopper_priority","value":""},{"description":{"content":"

Y or N, default is N. Validate the local call time and/or state call time before inserting lead in the hopper

\n","type":"text/plain"},"key":"hopper_local_call_time_check","value":""},{"description":{"content":"

1-20 characters, this updates the 'user' field in the ytel list table

\n","type":"text/plain"},"key":"user_field","value":""},{"description":{"content":"

3-12 digits, this updates the 'list_id' field in the ytel list table

\n","type":"text/plain"},"key":"list_id_field","value":""},{"description":{"content":"

1-6 characters, not punctuation or spaces (If status is DNC then the DNC option is ADDTODNC is required)

\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"

1-20 characters

\n","type":"text/plain"},"key":"vendor_lead_code","value":""},{"description":{"content":"

1-50 characters

\n","type":"text/plain"},"key":"source_id","value":""},{"description":{"content":"

overridden by auto-lookup of phone_code and area_code portion of phone number if applicable

\n","type":"text/plain"},"key":"gmt_offset_now","value":""},{"description":{"content":"

1-4 characters

\n","type":"text/plain"},"key":"title","value":""},{"description":{"content":"

1-30 characters

\n","type":"text/plain"},"key":"first_name","value":""},{"description":{"content":"

1 character

\n","type":"text/plain"},"key":"middle_initial","value":""},{"description":{"content":"

1-30 characters

\n","type":"text/plain"},"key":"last_name","value":""},{"description":{"content":"

1-100 characters

\n","type":"text/plain"},"key":"address1","value":""},{"description":{"content":"

1-100 characters

\n","type":"text/plain"},"key":"address2","value":""},{"description":{"content":"

1-100 characters

\n","type":"text/plain"},"key":"address3","value":""},{"description":{"content":"

1-50 characters

\n","type":"text/plain"},"key":"city","value":""},{"description":{"content":"

2 characters

\n","type":"text/plain"},"key":"state","value":""},{"description":{"content":"

1-50 characters

\n","type":"text/plain"},"key":"province","value":""},{"description":{"content":"

1-10 characters

\n","type":"text/plain"},"key":"postal_code","value":""},{"description":{"content":"

3 characters

\n","type":"text/plain"},"key":"country_code","value":""},{"description":{"content":"

U, M, F (Undefined, Male, Female) - defaults to 'U'

\n","type":"text/plain"},"key":"gender","value":""},{"description":{"content":"

YYYY-MM-DD

\n","type":"text/plain"},"key":"date_of_birth","value":""},{"description":{"content":"

1-12 characters

\n","type":"text/plain"},"key":"alt_phone","value":""},{"description":{"content":"

1-70 characters

\n","type":"text/plain"},"key":"email","value":""},{"description":{"content":"

1-100 characters

\n","type":"text/plain"},"key":"security_phrase","value":""},{"description":{"content":"

1-255 characters

\n","type":"text/plain"},"key":"comments","value":""},{"description":{"content":"

1-5 digits

\n","type":"text/plain"},"key":"rank","value":""},{"description":{"content":"

1-20 characters (user ID, Territory or user group)

\n","type":"text/plain"},"key":"owner","value":""},{"description":{"content":"

digits only, the number of attempts dialing the lead

\n","type":"text/plain"},"key":"called_count","value":""},{"description":{"content":"

Y or N. This will allow you to orride custom fields on update Lead

\n","type":"text/plain"},"key":"custom_override","value":""},{"description":{"content":"

Y or N. This will trim the number and convert it into 10 digits. This is useful to strip the Country code from the phone numbers. ie +19998881112 --> 9998881112

\n","type":"text/plain"},"key":"from_ytel_api","value":""},{"description":{"content":"

Y or N. This will update the existing number from the filter phone numbers. This only will work if the search_method=PHONE_NUMBER

\n","type":"text/plain"},"key":"updateNumber","value":""},{"description":{"content":"

Y or No. This can be used to add the phone number into a specific filter phone group on your system. You must include the filter ID in the filter_phone_group_id parameter.

\n","type":"text/plain"},"key":"addToFilterPhoneGroup","value":""},{"description":{"content":"

The unique filter group ID the phone number will be added to. addToFilterPhoneGroup is required to use this option.

\n","type":"text/plain"},"key":"filter_phone_group_id","value":""}],"variable":[]}},"response":[],"_postman_id":"fb9c2d03-6ac9-45cd-9838-c4c712a41a45"},{"name":"add_user","id":"12466a2d-8c7a-4ee0-b136-d0ef4163b5b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=add_user&user=101&pass=123Password&source=postman","description":"

adds a user to the system

Required Value: add_user

\n","type":"text/plain"},"key":"function","value":"add_user"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"}],"variable":[]}},"response":[],"_postman_id":"12466a2d-8c7a-4ee0-b136-d0ef4163b5b3"},{"name":"update_user","id":"9990b3aa-bf58-434c-90c9-bce6d62f14be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?user=&pass=&source=&function=&agent_user=&agent_pass=&agent_full_name=&agent_user_group=&voicemail_id=&email=&active=&campaign_rank=&campaign_grade=&camp_rg_only=&campaign_id=&in_group_rank=&in_group_grade=&in_group_rg_only=&in_group_id=","description":"

update_user provides the ability to update some agent settings in the system.

API User ID (Required)

\n","type":"text/plain"},"key":"user","value":""},{"description":{"content":"

API Password (Required)

\n","type":"text/plain"},"key":"pass","value":""},{"description":{"content":"

A description of what originated the API call, maximum 20 characters. (Required)

\n","type":"text/plain"},"key":"source","value":""},{"description":{"content":"

update_user (Required)

\n","type":"text/plain"},"key":"function","value":""},{"description":{"content":"

The Agent ID you wish to update. (Required)

\n","type":"text/plain"},"key":"agent_user","value":""},{"description":{"content":"

Set the new password for the Agent.

\n","type":"text/plain"},"key":"agent_pass","value":""},{"description":{"content":"

Change the Agents name.

\n","type":"text/plain"},"key":"agent_full_name","value":""},{"description":{"content":"

Change the Agents user group.

\n","type":"text/plain"},"key":"agent_user_group","value":""},{"description":{"content":"

Change the Agents Voicemail box.

\n","type":"text/plain"},"key":"voicemail_id","value":""},{"description":{"content":"

Change the email associated with the Agent.

\n","type":"text/plain"},"key":"email","value":""},{"description":{"content":"

'Y' or 'N'. Set agent the Agents account to active or inactive.

\n","type":"text/plain"},"key":"active","value":""},{"description":{"content":"

Changes the Agents campaign rank for 1 or all campaigns. Value can be between -9 and 9

\n","type":"text/plain"},"key":"campaign_rank","value":""},{"description":{"content":"

Changes the Agents icampaign grade for 1 or all campaigns. Value Must be between 1 - 9.

\n","type":"text/plain"},"key":"campaign_grade","value":""},{"description":{"content":"

0 or 1, this will set only one campaign rank/grade for this Agent, requires campaign_id to be set.

\n","type":"text/plain"},"key":"camp_rg_only","value":""},{"description":{"content":"

Only required for use with camp_rg_only.

\n","type":"text/plain"},"key":"campaign_id","value":""},{"description":{"content":"

Changes the Agents in_group rank for 1 or all in_groups. Value can be between -9 and 9

\n","type":"text/plain"},"key":"in_group_rank","value":""},{"description":{"content":"

Changes the Agents in group grade for 1 or all in groups. Value Must be between 1 - 9.

\n","type":"text/plain"},"key":"in_group_grade","value":""},{"description":{"content":"

0 or 1, this will set only one in_group rank/grade or this Agent, requires in_group_id to be set.

\n","type":"text/plain"},"key":"in_group_rg_only","value":""},{"description":{"content":"

Pass the in_group ID you wish to update the rank and/or grade of a specific Agent. Only required for use with in_group_rg_only.

\n","type":"text/plain"},"key":"in_group_id","value":""}],"variable":[]}},"response":[],"_postman_id":"9990b3aa-bf58-434c-90c9-bce6d62f14be"},{"name":"add_phone","id":"f7167241-35c1-490b-9954-4e0e6f5b95cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=add_phone&user=101&pass=123Password&source=postman","description":"

adds a phone to the system

Required Value: add_phone

\n","type":"text/plain"},"key":"function","value":"add_phone"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"}],"variable":[]}},"response":[],"_postman_id":"f7167241-35c1-490b-9954-4e0e6f5b95cb"},{"name":"update_phone","id":"267640f1-3f33-48ec-9dfa-8cb0cc8c613f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=update_phone&user=101&pass=123Password&source=postman","description":"

updates or deletes an existing phone record in the system

Required Value: update_phone

\n","type":"text/plain"},"key":"function","value":"update_phone"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"}],"variable":[]}},"response":[],"_postman_id":"267640f1-3f33-48ec-9dfa-8cb0cc8c613f"},{"name":"add_phone_alias","id":"04c13a0b-dbf8-4f63-bf06-b748f5636a93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=add_phone_alias&user=101&pass=123Password&source=postman","description":"

adds a phone alias record to the system

Required Value: add_phone_alias

\n","type":"text/plain"},"key":"function","value":"add_phone_alias"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"}],"variable":[]}},"response":[],"_postman_id":"04c13a0b-dbf8-4f63-bf06-b748f5636a93"},{"name":"update_phone_alias","id":"f636dfeb-ebc4-417d-9ed8-952bca807beb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=update_phone_alias&user=101&pass=123Password&source=postman","description":"

updates or deletes an existing phone alias record in the system

Required Value: update_phone_alias

\n","type":"text/plain"},"key":"function","value":"update_phone_alias"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"}],"variable":[]}},"response":[],"_postman_id":"f636dfeb-ebc4-417d-9ed8-952bca807beb"},{"name":"add_list","id":"70100b06-1679-4ade-876f-38529164b004","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=add_list&user=101&pass=123Password&source=postman","description":"

adds a list to the system

Required Value: add_list

\n","type":"text/plain"},"key":"function","value":"add_list"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"}],"variable":[]}},"response":[],"_postman_id":"70100b06-1679-4ade-876f-38529164b004"},{"name":"update_list","id":"c1a07ae9-0965-4c01-9b37-6002583e649d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=update_list&user=101&pass=123Password&source=postman","description":"

updates list settings in the system, reset leads in list, delete list

Required Value: update_list

\n","type":"text/plain"},"key":"function","value":"update_list"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"}],"variable":[]}},"response":[],"_postman_id":"c1a07ae9-0965-4c01-9b37-6002583e649d"},{"name":"moh_list","id":"b2d1c674-d60e-452e-aa24-66d6d3f5d1d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=moh_list&user=101&pass=123Password&source=postman&format=format of the output&comments=name of the field to populate","description":"

outputs a list of music on hold classes in the system

Required Value: moh_list

\n","type":"text/plain"},"key":"function","value":"moh_list"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"},{"key":"format","value":"format of the output"},{"key":"comments","value":"name of the field to populate"}],"variable":[]}},"response":[],"_postman_id":"b2d1c674-d60e-452e-aa24-66d6d3f5d1d2"},{"name":"sounds_list","id":"20b26579-5dbb-4d30-9d7a-912190f580b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=sounds_list&user=101&pass=123Password&source=postman&format=&stage=&comments=","description":"

outputs a list of audio files from the audio store

Required Value: sounds_list

\n","type":"text/plain"},"key":"function","value":"sounds_list"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"123Password"},{"description":{"content":"

description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"},{"description":{"content":"

format of the output(tab, link, selectframe)

\n","type":"text/plain"},"key":"format","value":""},{"description":{"content":"

how to sort the output(date, size, name)

\n","type":"text/plain"},"key":"stage","value":""},{"description":{"content":"

name of the field to populate

\n","type":"text/plain"},"key":"comments","value":""}],"variable":[]}},"response":[],"_postman_id":"20b26579-5dbb-4d30-9d7a-912190f580b8"},{"name":"add_fpg_phone","id":"be86661b-e7b0-4e34-829d-8235356c7149","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non_agent.php?function=add_fpg_phone&user=101&pass=password&source=postman&phone_number=9998881112&group_id=1111","description":"

This allows you to add a phone number to the filter phone group using an API.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6613f312-546a-4cb9-b603-71fc960baced","id":"6613f312-546a-4cb9-b603-71fc960baced","name":"Non-Agent API","type":"folder"}},"urlObject":{"protocol":"https","path":["x5","api","non_agent.php"],"host":["YOUR_URL","ytel","com"],"query":[{"key":"function","value":"add_fpg_phone"},{"key":"user","value":"101"},{"key":"pass","value":"password"},{"key":"source","value":"postman"},{"key":"phone_number","value":"9998881112"},{"key":"group_id","value":"1111"}],"variable":[]}},"response":[],"_postman_id":"be86661b-e7b0-4e34-829d-8235356c7149"},{"name":"agent_list","id":"cd34d4f6-d569-4a36-8fa3-7ed51c04a8e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR_URL.ytel.com/x5/api/non-agent?ytel_token=&accountSid=accountSID&user=101&pass=xxxxxx&source=postman&action_type=agent_list","description":"

This allows you to add a phone number to the filter phone group using an API.

Ask a support team member what your token is

\n","type":"text/plain"},"key":"ytel_token","value":""},{"description":{"content":"

Account SID

\n","type":"text/plain"},"key":"accountSid","value":"accountSID"},{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101"},{"description":{"content":"

API Password

\n","type":"text/plain"},"key":"pass","value":"xxxxxx"},{"description":{"content":"

Description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"},{"description":{"content":"

Required Static Value: agent_list

\n","type":"text/plain"},"key":"action_type","value":"agent_list"}],"variable":[]}},"response":[],"_postman_id":"cd34d4f6-d569-4a36-8fa3-7ed51c04a8e6"},{"name":"available_agents_totals","id":"268524e3-c205-4cdb-9d69-229b9a5ab10d","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the v4 Authentication endpoint.

\n"}],"url":"https://YOUR_URL.ytel.com/api/ytel/non-agent?user=101x&source=postman&action_type=available_agents_totals&ingroupid=ingroupid","description":"

This allows you to get a list of all available agents.

\n","urlObject":{"protocol":"https","path":["api","ytel","non-agent"],"host":["YOUR_URL","ytel","com"],"query":[{"description":{"content":"

API User ID

\n","type":"text/plain"},"key":"user","value":"101x"},{"description":{"content":"

Description of what originated the API call maximum 20 characters

\n","type":"text/plain"},"key":"source","value":"postman"},{"description":{"content":"

Required Static Value: agent_list

\n","type":"text/plain"},"key":"action_type","value":"available_agents_totals"},{"description":{"content":"

Optional: Inbound Group Id

\n","type":"text/plain"},"key":"ingroupid","value":"ingroupid"}],"variable":[]}},"response":[],"_postman_id":"268524e3-c205-4cdb-9d69-229b9a5ab10d"}],"id":"6613f312-546a-4cb9-b603-71fc960baced","description":"

The Non Agent API is a collection of API calls that can be used to interact with Ytel's Contact Center System. In order to use the API's you must first create an API user within your Admin interface. Please Contact Ytel Support at 800-382-4913 for assistance with creating an API user.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"553242de-2605-4131-8a5b-9f95c3b989d4"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"10602188-6860-44be-a681-386369e00d68"}}],"_postman_id":"6613f312-546a-4cb9-b603-71fc960baced"},{"name":"YCC Global API","item":[{"name":"Get Global API","id":"c5293671-8753-41d1-9f43-7709155d6e8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"case\":[\n \"cam\",\n \"inboundgroupoption\",\n \"callmenu\",\n \"voicemail\",\n \"agent\",\n \"agentgroup\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/global-api","urlObject":{"protocol":"https","path":["api","v2","global-api"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5293671-8753-41d1-9f43-7709155d6e8e"}],"id":"398d23f8-aeb0-41d4-a025-a312efe1ebed","description":"

YCC global api endpoints allow for retrieving various lists of data.

Authorization: Bearer Token

This folder is using an authorization helper from folder CPaaS API.

Request Headers

Accept: application/json

Content-Type: application/json

POST Get Global API

https://ycc-api.ytel.com/api/v2/global-api

This api end point retrieves lists of campaigns, agents, agent groups, voicemails, inbound groups and call menus.

{\n    \"case\":[\n    \"cam\",\n    \"inboundgroupoption\",\n    \"callmenu\",\n    \"voicemail\",\n    \"agent\",\n    \"agentgroup\"\n    ]\n}\n\n

Fields within data:

cam: Contains list of campaigns.
\n
agent: Contains list of agents.
\n
agentgroup: Contains list of agent groups.
\n
voicemail: List of voicemails.
\n
ingroupoption: List of in-groups.
\n
callmenu: List of call menus.
\n

Fields within a campaign:

campaign_id: Campaign id.
\n
campaign_name: Name of campaign.
\n

Fields within an agent:

user_id: Internal user id.
\n
User: User id associated with an agent.
\n
full_name: Name of user.
\n
user_group: User group user is associated with.
\n

Fields within an agentgroup:

user_group: User group id.
\n
group_name: User group name.
\n

Fields within voicemail:

voicemail_id: Voicemail id.
\n
fullname: Voicemail name.
\n
email: Email assigned to voicemail.
\n

Fields within ingroupoption:

group_id: In-group id.
\n
group_name: In-group name.
\n

Fields within callmenu:

menu_id: Call menu id.

\n","_postman_id":"398d23f8-aeb0-41d4-a025-a312efe1ebed","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b6626842-49af-4640-b148-2c29843e1d6e","id":"b6626842-49af-4640-b148-2c29843e1d6e","name":"CCaaS API","type":"folder"}}},{"name":"YCC Campaign Data Mix","item":[{"name":"Get Campaign List","id":"6e0ecf29-69b5-41ad-bf36-b8f3b8a821e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/campaign-list-mix?limit=10000&page=1","urlObject":{"protocol":"https","path":["api","v2","campaign-list-mix"],"host":["ycc-api","ytel","com"],"query":[{"key":"limit","value":"10000"},{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"6e0ecf29-69b5-41ad-bf36-b8f3b8a821e7"},{"name":"Get Campaign Data Mix List","id":"31b3ee63-1a4c-428d-8a17-e56da6de4f4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/campaign-mix-options-edit?campaign_id=cid","urlObject":{"protocol":"https","path":["api","v2","campaign-mix-options-edit"],"host":["ycc-api","ytel","com"],"query":[{"key":"campaign_id","value":"cid"}],"variable":[]}},"response":[],"_postman_id":"31b3ee63-1a4c-428d-8a17-e56da6de4f4b"},{"name":"Get Campaign Statuses","id":"affd6de2-252c-4a86-bf41-6ff3b7b5d199","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/campaign-mix-options-lists?campaign_id=cid","urlObject":{"protocol":"https","path":["api","v2","campaign-mix-options-lists"],"host":["ycc-api","ytel","com"],"query":[{"key":"campaign_id","value":"cid"}],"variable":[]}},"response":[],"_postman_id":"affd6de2-252c-4a86-bf41-6ff3b7b5d199"},{"name":"Get Campaign List Mix","id":"76a56f76-05ef-4565-b3f1-39b5eac1fd97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/campaign-mix-options-lists-edit?list_mix_id=lmid","urlObject":{"protocol":"https","path":["api","v2","campaign-mix-options-lists-edit"],"host":["ycc-api","ytel","com"],"query":[{"key":"list_mix_id","value":"lmid"}],"variable":[]}},"response":[],"_postman_id":"76a56f76-05ef-4565-b3f1-39b5eac1fd97"},{"name":"Activate Campaign List Mix","id":"c32f6ab1-3a01-472f-9f2f-b05bd31524f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"campaign_id\":\"cid\",\n \"vcl_id\":\"vclid\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/active-campaign-mix-lists","urlObject":{"protocol":"https","path":["api","v2","active-campaign-mix-lists"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c32f6ab1-3a01-472f-9f2f-b05bd31524f8"},{"name":"Create Campaign List Mix","id":"590c0289-fe16-4993-a2be-6e15aa61fa90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"vcl_id\":\"vclid\",\n \"vcl_name\":\"vcl name\",\n \"campaign_id\":\"cid\",\n \"dial_status\":[\"A\",\"ADAIR\"],\n \"list_id\":\"1000\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/create-campaign-list-mix","urlObject":{"protocol":"https","path":["api","v2","create-campaign-list-mix"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"590c0289-fe16-4993-a2be-6e15aa61fa90"},{"name":"Update Campaign List Mix","id":"a325ca72-0fe0-47b0-b339-b13103d643b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"campaign_id\":\"fakename\",\n \"vcl_id\":\"jbtest1\",\n \"vcl_name\":\"JB Test 2\",\n \"vcl_lists\":[\n {\n \"list_id\":1000,\n \"mix_percentage\":40,\n \"statuses\":[\"XDROP\",\"ADC\",\"AFAX\"]\n },\n {\n \"list_id\":909,\n \"mix_percentage\":60,\n \"statuses\":[\"SVYREC\",\"SVYVM\",\"TIMEOT\",\"XFER\",\"XDROP\"]\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"https://ycc-api-dev.ytel.com/api/update-campaign-list-mix","urlObject":{"protocol":"https","path":["api","update-campaign-list-mix"],"host":["ycc-api-dev","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a325ca72-0fe0-47b0-b339-b13103d643b9"},{"name":"Delete Campaign List Mix","id":"1a72af3f-5f0e-4c50-9bb1-f6beff222c2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

Authorization: Bearer Token

This folder is using an authorization helper from folder CPaaS API.

Request Headers

Accept: application/json

Content-Type: application/json

GET Get Campaign List

https://ycc-api.ytel.com/api/v2/campaign-mix-list?limit=10000&page=1

Get a list of campaigns and their data mixes.

Fields within data array:

campaign_id: Campaign id.
\n
campaign_name: Campaign name.
\n
list_mix: Array of list mix ids.
\n

GET Get Campaign Data Mix List

https://ycc-api.ytel.com/api/v2/campaign-mix-options-edit?campaign_id=id

Get a list of a data mixes for a campaign.

Fields within data array:

result: Array of data mixes.
\n
dial_status: Array of statuses.
\n
lists: Array of lists.
\n

Fields within data::result array:

vcl_id: Data mix list id.
\n
vcl_name: Data mix list name.
\n
campaign_id: Campaign id.
\n
mix_method: Mix Method.
\n
lmc_rows: Array of lists.
\n

Fields within data::result::lmc_rows:

description: List description.
\n
list_id: List id.
\n
priority: Data mix list order priority.
\n
mix_percentage: Mix percentage.
\n
statuses: String of statuses.
\n
status_list: Array of statuses.
\n

Fields within data::dial_status:

status: Status id.
\n
option_title: Status id and name.
\n

Fields within data:lists.

list_id: List id.
\n
list_name: List name.
\n

GET Get Campaign Statuses

https://ycc-api.ytel.com/api/v2/campaign-mix-options-lists?campaign_id=id

Get a list of campaign statuses.

Fields within data array:

dial_status: Array of campaign statuses.
\n
campaign_id: Campaign id.
\n
lists: Array of lists.
\n

Fields within data::dial_status:

status: Campaign status id.
\n
option_title: Campaign status id combined with campaign status name.
\n

Fields within data::lists:

list_id: List id.
\n
list_name: List name.
\n

GET Get Campaign List Mix

https://ycc-api.ytel.com/api/v2/campaign-mix-options-lists?campaign_id=id

Get a campaign's list mix.

Fields within data array:

0: Campaign list mix details.
\n
dial_status: Array of campaign statuses.
\n
lists: Array of lists.
\n

Field within data::0:

vcl_id: Campaign list mix id.
\n
vcl_name: Campaign list mix name.
\n
campaign_id: Campaign id.
\n
mix_method: Mix method.
\n
status: ACTIVE or INACTIVE.
\n
lmc_rows: Array of list ids and statuses within data list mix.
\n

Fields within data::dial_status:

status: Campaign status id.
\n
option_title: Campaign status id combined with campaign status name.
\n

Fields within data::lists:

list_id: List id.
\n
list_name: List name.
\n

POST Activate Campaign List Mix

Note: Only one list mix can be active at a time per campaign.

https://ycc-api.ytel.com/api/v2/active-campaign-mix-lists

{\n    \"campaign_id\": \"id\", \n    \"vcl_id\": \"vlc_id\", \n}\n\n

Fields:

campaign_id: Campaign id.
\n
vcl_id: Vicidial campaign list mix id to be activated.
\n

POST Create Campaign List Mix

https://ycc-api.ytel.com/api/v2/create-campaign-list-mix

{\n    \"vcl_id\":\"lmixid\",\n    \"vcl_name\":\"List Mix Name\",\n    \"campaign_id\":\"ctetid\",\n    \"dial_status\":[\"A\",\"ADAIR\"],\n    \"list_st\":\"1000\"\n}\n\n

Fields:

vcl_id: Vicidial campaign list mix id to be activated.
\n
vcl_name: Vicidial campaign list mix name.
\n
campaign_id: Campaign id.
\n
dial_status: Array of statuses associated with a list id.
\n
list_id: List id.
\n

POST Update Campaign List Mix

Update allows you to add list ids, remove list ids, and edit the statuses and mix percentage associated with a list id. There must be at list 1 list id in a mix and at least one status associated with each list id. Mix percentages must total 100%.

https://ycc-api.ytel.com/api/v2/update-campaign-list-mix

{\n    \"campaign_id\":\"cid\",\n    \"vcl_id\":\"lmixid\",\n    \"vcl_lists\":[\n        {\n            \"list_id\":1000,\n            \"mix_percentage\":40,\n            \"statuses\":[\"XDROP\",\"ADC\",\"AFAX\"]\n        },\n        {\n            \"list_id\":9090,\n            \"mix_percentage\":60,\n            \"statuses\":[\"SVYREC\",\"SVYVM\",\"TIMEOT\",\"XFER\",\"XDROP\"]\n        }\n    ]\n}\n\n

Fields:

campaign_id: Campaign id.
\n
vcl_id: Vicidial campaign list mix id to be activated.
\n
vcl_lists: Array containing mix percentage and statuses per list id.
\n
list_id: List id.
\n
mix_percentage: Mix Percentage.
\n
statuses: Array of statuses.
\n

POST Delete Campaign List Mix

https://ycc-api.ytel.com/api/v2/campaign-mix-options-delete

{\n    \"campaign_id\":\"cid\",\n    \"vcl_id\":\"clmid\"\n}\n\n

Fields:

campaign_id: Campaign id.
\n
vcl_id: Vicidial campaign list mix id to be deleted.
\n

\n","_postman_id":"d2f373ed-dd2a-40ca-b8a7-130ddc1e3c56","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b6626842-49af-4640-b148-2c29843e1d6e","id":"b6626842-49af-4640-b148-2c29843e1d6e","name":"CCaaS API","type":"folder"}}},{"name":"YCC Inbound Queue","item":[{"name":"Get Inbound Queue","id":"85a86b7f-db86-46df-8a46-d4d4019d87b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"url":"https://ycc-api.ytel.com/api/v2/inbound-queue/details/:group_id","urlObject":{"protocol":"https","path":["api","v2","inbound-queue","details",":group_id"],"host":["ycc-api","ytel","com"],"query":[],"variable":[{"description":{"content":"

Id of inbound queue group.

\n","type":"text/plain"},"type":"any","value":"test","key":"group_id"}]}},"response":[],"_postman_id":"85a86b7f-db86-46df-8a46-d4d4019d87b8"},{"name":"Get Inbound Queue List","id":"1fdd213e-f395-476f-9119-7fb020714cfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"url":"https://ycc-api.ytel.com/api/v2/inbound-queue?limit=1000","urlObject":{"protocol":"https","path":["api","v2","inbound-queue"],"host":["ycc-api","ytel","com"],"query":[{"key":"limit","value":"1000"}],"variable":[]}},"response":[],"_postman_id":"1fdd213e-f395-476f-9119-7fb020714cfd"},{"name":"Clone Inbound Queue","id":"eb8a6653-6f3f-4587-9d16-3a65d206782b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"group_id\": \"TEST\", \n \"group_name\": \"TEST NAME\", \n \"from_inbound_id\": \"AGENTDIRECT\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/inbound-queue-clone","urlObject":{"protocol":"https","path":["api","v2","inbound-queue-clone"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"eb8a6653-6f3f-4587-9d16-3a65d206782b"},{"name":"Update Inbound Queue","id":"35c1fa75-6456-49df-ae76-690e4b7ff41a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"group_id\":\"TEST2\",\n \"group_name\":\"TEST 2\",\n \"group_color\":\"#000001\",\n \"active\":\"Y\",\n \"web_form_address\":null,\n \"voicemail_ext\":null,\n \"next_agent_call\":\"random\",\n \"fronter_display\":\"Y\",\n \"ingroup_script\":null,\n \"get_call_launch\":\"NONE\",\n \"drop_call_seconds\":360,\n \"drop_action\":\"MESSAGE\",\n \"drop_exten\":\"8307\",\n \"call_time_id\":\"24hours\",\n \"after_hours_action\":\"MESSAGE\",\n \"after_hours_message_filename\":\"vm-goodbye\",\n \"after_hours_exten\":\"8300\",\n \"after_hours_voicemail\":null,\n \"welcome_message_filename\":\"---NONE---\",\n \"moh_context\":\"default\",\n \"onhold_prompt_filename\":\"generic_hold\",\n \"prompt_interval\":60,\n \"agent_alert_exten\":\"ding\",\n \"agent_alert_delay\":1000,\n \"default_xfer_group\":\"---NONE---\",\n \"queue_priority\":0,\n \"drop_inbound_group\":\"---NONE---\",\n \"ingroup_recording_override\":\"DISABLED\",\n \"ingroup_rec_filename\":\"NONE\",\n \"afterhours_xfer_group\":\"---NONE---\",\n \"play_place_in_line\":\"N\",\n \"play_estimate_hold_time\":\"N\",\n \"action_xfer_cid\":\"CUSTOMER\",\n \"extension_appended_cidname\":\"N\",\n \"hold_time_option\":\"NONE\",\n \"hold_time_option_seconds\":360,\n \"hold_time_option_exten\":\"8300\",\n \"hold_time_option_voicemail\":\"\",\n \"hold_time_option_xfer_group\":\"---NONE---\",\n \"hold_time_option_callback_filename\":\"vm-hangup\",\n \"hold_time_option_callback_list_id\":999,\n \"hold_recall_xfer_group\":\"---NONE---\",\n \"no_delay_call_route\":\"N\",\n \"play_welcome_message\":\"ALWAYS\",\n \"no_agent_no_queue\":\"N\",\n \"no_agent_action\":\"MESSAGE\",\n \"no_agent_action_value\":\"nbdy-avail-to-take-call|vm-goodbye\",\n \"web_form_address_two\":null,\n \"start_call_url\":null,\n \"dispo_call_url\":null,\n \"ignore_list_script_override\":\"N\",\n \"hold_time_option_minimum\":0,\n \"hold_time_option_press_filename\":\"to-be-called-back|digits/1\",\n \"hold_time_option_callmenu\":\"\",\n \"hold_time_option_no_block\":\"N\",\n \"hold_time_option_prompt_seconds\":10,\n \"onhold_prompt_no_block\":\"N\",\n \"onhold_prompt_seconds\":10,\n \"hold_time_second_option\":\"NONE\",\n \"hold_time_third_option\":\"NONE\",\n \"wait_hold_option_priority\":\"WAIT\",\n \"wait_time_option\":\"NONE\",\n \"wait_time_second_option\":\"NONE\",\n \"wait_time_third_option\":\"NONE\",\n \"wait_time_option_seconds\":120,\n \"wait_time_option_exten\":\"8300\",\n \"wait_time_option_voicemail\":\"\",\n \"wait_time_option_xfer_group\":\"---NONE---\",\n \"wait_time_option_callmenu\":\"\",\n \"wait_time_option_callback_filename\":\"vm-hangup\",\n \"wait_time_option_callback_list_id\":999,\n \"wait_time_option_press_filename\":\"to-be-called-back|digits/1\",\n \"wait_time_option_no_block\":\"N\",\n \"wait_time_option_prompt_seconds\":10,\n \"calculate_estimated_hold_seconds\":0,\n \"na_call_url\":\"N\",\n \"group_calldate\":\"2024-07-08 14:40:12\",\n \"drop_callmenu\":\"\",\n \"after_hours_callmenu\":\"\",\n \"user_group\":\"---ALL---\",\n \"max_calls_method\":\"DISABLED\",\n \"max_calls_count\":0,\n \"max_calls_action\":\"NO_AGENT_NO_QUEUE\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/inbound-queue/update","urlObject":{"protocol":"https","path":["api","v2","inbound-queue","update"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"35c1fa75-6456-49df-ae76-690e4b7ff41a"},{"name":"Delete Inbound Queue","id":"40079e4c-cfb2-49a9-b86f-7a08a24d0dac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"url":"https://ycc-api.ytel.com/api/v2/inbound-queue/delete?group_id=TEST","urlObject":{"protocol":"https","path":["api","v2","inbound-queue","delete"],"host":["ycc-api","ytel","com"],"query":[{"description":{"content":"

Inbound quere id to be deleted.

\n","type":"text/plain"},"key":"group_id","value":"TEST"}],"variable":[]}},"response":[],"_postman_id":"40079e4c-cfb2-49a9-b86f-7a08a24d0dac"}],"id":"b0e3e996-8216-4db6-80c3-651f209ee44e","description":"

YCC inbound queue endpoints allow for cloning, updating, deleting and viewing data about inbound queues.

Authorization: Bearer Token

This folder is using an authorization helper from folder CPaaS API.

Request Headers

Accept: application/json

Content-Type: application/json

GET Get Inbound Queue

https://ycc-api.ytel.com/api/v2/inbound-queue/details/{group_id}

Get an inbound queue's details. {group_id} is the inbound queue id.

Fields within data:

group_id: Inbound queue id.
\n
group_name: Inbound queue name.
\n
group_color: Inbound queue color.
\n
active: Y means inbound queue is active, else N.
\n
web_form_address: Web page that automatically displays on agent's screen when they get a call from that group. (nullable)
\n
voicemail_ext: Extension calls are routd to when no agents are available. (nullable)
\n
next_agent_call: Determines order in which calls are routed to available agents. Options are (longest_wait_time, random, inbound_group_rank, oldest_call_start, oldest_call_finish, oldest_inbound_call_start, oldest_inbound_call_finish, oldest_inbound_filtered_call_start, oldest_inbound_filtered_call_finish, overall_user_level, campaign_rank, ingroup_grade_random, campaign_grade_random, fewest_calls, fewest_calls_campaign, overall_user_level_wait_time, campaign_rank_wait_time, fewest_calls_wait_time, fewest_calls_campaign_wait_time, inbound_group_rank_wait_time).
\n
fronter_display: Y if fronter is shown to the closer or inbound agent, else N.
\n
ingroup_script: Incoming call script presented to an agent.
\n
get_call_launch: What displays on an agent's screen when an incoing call is delivered. Options are (NONE, SCRIPT, SCRIPTTWO, WEBFORM, WEBFORMTWO, WEBFORMTHREE, FORM, EMAIL).
\n
drop_call_seconds: Max amount of time a call will wait in the queue before a drop action is executed.
\n
drop_action: Options are (HANGUP, MESSAGE, VOICEMAIL, IN_GROUP, CALLMENU, VMAIL_NO_INST).
\n
drop_exten: The extension a dropped caller is routed to.
\n
call_time_id: Call times when inbound queue can receive calls.
\n
after_hours_action: Options are (HANGUP, MESSAGE, EXTENSION, VOICEMAIL, IN_GROUP, CALLMENU, VMAIL_NO_INST).
\n
after_hours_message_filename: Plays message to caller during designated after hours.
\n
after_hours_exten: Where incoming call are routed to during designated after hours.
\n
after_hours_voicemail: Voicemail for incoming calls during designated after hours.
\n
welcome_message_filename: Audio file played to a caller as a welcome message.
\n
moh_context: Dialplan context that is used for a caller who is placed on hold with music.
\n
onhold_prompt_filename: Audio file played when caller is on hold.
\n
prompt_interval: Frequency interval in seconds when onhold prompt is played.
\n
agent_alert_exten: Special extension to which an inbound call is routed before being sent to an agent.
\n
agent_alert_delay: Adds pause between when a call is sent to an agent and when the agent's web interface displays the call information.
\n
default_xfer_group: Destination queue to which calls are transferred by default.
\n
queue_priority: Determins order in which calls are retrieved. The lower the number the higher the priority.
\n
drop_inbound_group: Group id where abandoned inbounds calls are sent to.
\n
inbound_recording_override: Determines how call recording is handled for calls routed to that group. Options are (DISABLED, NEVER, ONDEMAND, ALLCALLS, ALLFORCE)
\n
ingroup_rec_filename: Naming convention for audio files.
\n
afterhours_xfer_group: Defines where to route call if it arrives outside the designated operating hours.
\n
play_place_in_line: Y/N.
\n
play_estimate_hold_time: Y/N.
\n
action_xfer_cid: Caller ID displayed to the agent while receiving a transfered call.
\n
extension_appended_cidname: Modify caller id's name to agent. Options are (Y, N, Y_USER, Y_WITH_CAMPAIGN, Y_USER_WITH_CAMPAIGN)
\n
hold_time_option: Alternative action a caller can take if wait time is longer than expected.
\n
hold_time_option_seconds: Wait time duration until action is triggered.
\n
hold_time_option_exten: Extension a caller will be sent to if their wait time exeeds its defined limit.
\n
hold_time_option_voicemail: Voicemail used when a caller's wait time exeeds its defined limit.
\n
hold_time_option_xfer_group: Group a caller will be sent to if their wait time exeeds its defined limit.
\n
hold_time_option_callback_filename: Audio file used when a caller's wait time exeeds its defined limit.
\n
hold_time_option_callback_list_id: List id a caller is saved to if their wait time exeeds its defined limit.
\n
hold_recall_xfer_group: Which group to route a held call to for a recall transfer.
\n
no_delay_call_route: Y/N.
\n
play_welcome_message: Options are (ALWAYS, NEVER, IF_WAIT_ONLY, YES_UNLESS_NODELAY)
\n
no_agent_no_queue: Options are (N, Y, NO_PAUSED, NO_READY).
\n
no_agent_action: Options are (CALLMENU, INGROUP, DID, MESSAGE, EXTENSION, VOICEMAIL, VMAIL_NO_INST).
\n
no_agent_action_value: Determines what happens to an inbound call when there are no agents logged in and ready to take the call.
\n
web_form_address_two: URL for second web form displayed to agent.
\n
start_call_url: External web url triggered when a call is successfully transfered to an agent.
\n
dispo_call_url: External web url triggered when an agent disposition's a call.
\n
ignore_list_script_override: Y/N.
\n
hold_time_option_minimum: Number of seconds a caller must be on hold until hold time option is executed.
\n
hold_time_option_press_filename: Audio file played when caller has been on hold for a specific amount of time.
\n
hold_time_option_callmenu: IVR call menu used when a caller has been on hold for a specific amount of time.
\n
hold_time_option_no_block: Y/N
\n
hold_time_option_prompt_seconds: How long on hold prompt audio message can play without blocking other calls in the queue.
\n
onhold_prompt_no_block: Y/N
\n
onhold_prompt_seconds: Time interval a periodic message is player to callers waiting in the queue.
\n
hold_time_second_option: Overflow option that is triggered after the hold time option seconds have been exceeded.
\n
hold_time_third_option: Overflow option that is triggered after the hold time option seconds have been exceeded for a third time.
\n
wait_time_option_priority: Options are (WAIT, HOLD, BOTH)
\n
wait_time_option: First action triggered after a caller has been waiting in the queue for a specified interval.
\n
wait_time_second_option: Second action triggered after a caller has been waiting in the queue for a specified interval.
\n
wait_time_third_option: Third action triggered after a caller has been waiting in the queue for a specified interval.
\n
wait_time_option_seconds: specifies the amount of time, in seconds, that an inbound caller must wait on hold before the special \"Wait Time Option\" is presented.
\n
wait_time_option_exten: specifies an extension for callers to use if they want to exit the waiting queue.
\n
wait_time_option_voicemail: Specifies the voicemail box where a caller is directed if they choose to leave the queue
\n
wait_time_option_xfer_group: Specifies a destination inbound group for a caller to be transferred to.
\n
wait_time_option_callmenu: Routes a waiting caller to a specific call menu after a predefined period.
\n
wait_time_option_callback_filename: The audio file that an inbound caller hears when they choose the option to receive a callback instead of continuing to wait on hold.
\n
wait_time_option_callback_list_id: List ID where a customer's call is placed when they opt for a callback while waiting in an inbound queue.
\n
wait_time_option_press_filename: Name of the sound file that is played to a caller after they have been on hold for a specified amount of time.
\n
wait_time_option_no_block: Y/N
\n
wait_time_option_prompt_seconds: Determines how long to wait before playing an audio prompt to a caller who is waiting in a queue.
\n
calculate_estimated_hold_seconds: Estimates the waiting time for an inbound call before it is connected to an agent.
\n
na_call_url: Executes a specified web address when a call is not connected to a live agent.
\n
group_calldate: Timestamp of a call associated with a specific agent's user group.
\n
drop_callmenu: Routing strategy used to handle dropped calls.
\n
after_hours_callmenu: Specifies which Call Menu to use when a call arrives outside of the defined business hours.
\n
user_group: Agent group id associated with inbound queue.
\n
max_calls_method: Options are (TOTAL, IN_QUEUE, DISABLED).
\n
max_calls_count: limits the number of concurrent calls that can be handled by agents assigned to that group.
\n
max_calls_action: Options are (DROP, AFTERHOURS, NO_AGENT_NO_QUEUE, AREACODE_FILTER).
\n
modify_stamp: Datetime when inbound queue was last modified.
\n

GET Get Inbound Queue List

https://ycc-api.ytel.com/api/v2/inbound-queue?limit=1000

Get a list of inbound queues.

Fields within each object listed by data:

group_id: Inbound queue id.
\n
group_name: Inbound queue name.
\n
group_color: Inbound group color.
\n
active: Y if inbound queue is active, else N.
\n
queue_priority: The higher the number, the higher the queue priorty.
\n
call_time_id: Dictates the day and times when the system will accept and route incoming calls.
\n

POST Clone Inbound Queue

https://ycc-api.ytel.com/api/v2/inbound-queue-clone

Clone an inbound queue.

{\n    \"group_id\": \"test1\", \n    \"group_name\": \"Test 1\", \n    \"from_inbound_id\": \"test2\"\n}\n\n

Fields:

group_id: New inbound queue id
\n
group_name: New inbound queue name.
\n
from_inbound_id: Inbound queue id that is getting cloned.
\n

POST Update Inbound Queue

https://ycc-api.ytel.com/api/v2/inbound-queue/update

group_id is the inbound queue getting updated.

{\n    \"group_id\": \"test1\",\n    \"group_name\":\"GROUP2\",\n    \"group_color\":\"#000001\",\n    \"active\":\"Y\",\n    \"web_form_address\":null,\n    \"voicemail_ext\":null,\n    \"next_agent_call\":\"random\",\n    \"fronter_display\":\"Y\",\n    \"ingroup_script\":null,\n    \"get_call_launch\":\"NONE\",\n    \"drop_call_seconds\":360,\n    \"drop_action\":\"MESSAGE\",\n    \"drop_exten\":\"8307\",\n    \"call_time_id\":\"24hours\",\n    \"after_hours_action\":\"MESSAGE\",\n    \"after_hours_message_filename\":\"vm-goodbye\",\n    \"after_hours_exten\":\"8300\",\n    \"after_hours_voicemail\":null,\n    \"welcome_message_filename\":\"---NONE---\",\n    \"moh_context\":\"default\",\n    \"onhold_prompt_filename\":\"generic_hold\",\n    \"prompt_interval\":60,\n    \"agent_alert_exten\":\"ding\",\n    \"agent_alert_delay\":1000,\n    \"default_xfer_group\":\"---NONE---\",\n    \"queue_priority\":0,\n    \"drop_inbound_group\":\"---NONE---\",\n    \"ingroup_recording_override\":\"DISABLED\",\n    \"ingroup_rec_filename\":\"NONE\",\n    \"afterhours_xfer_group\":\"---NONE---\",\n    \"play_place_in_line\":\"N\",\n    \"play_estimate_hold_time\":\"N\",\n    \"action_xfer_cid\":\"CUSTOMER\",\n    \"extension_appended_cidname\":\"N\",\n    \"hold_time_option\":\"NONE\",\n    \"hold_time_option_seconds\":360,\n    \"hold_time_option_exten\":\"8300\",\n    \"hold_time_option_voicemail\":\"\",\n    \"hold_time_option_xfer_group\":\"---NONE---\",\n    \"hold_time_option_callback_filename\":\"vm-hangup\",\n    \"hold_time_option_callback_list_id\":999,\n    \"hold_recall_xfer_group\":\"---NONE---\",\n    \"no_delay_call_route\":\"N\",\n    \"play_welcome_message\":\"ALWAYS\",\n    \"no_agent_no_queue\":\"N\",\n    \"no_agent_action\":\"MESSAGE\",\n    \"no_agent_action_value\":\"nbdy-avail-to-take-call|vm-goodbye\",\n    \"web_form_address_two\":null,\n    \"start_call_url\":null,\n    \"dispo_call_url\":null,\n    \"ignore_list_script_override\":\"N\",\n    \"hold_time_option_minimum\":0,\n    \"hold_time_option_press_filename\":\"to-be-called-back|digits/1\",\n    \"hold_time_option_callmenu\":\"\",\n    \"hold_time_option_no_block\":\"N\",\n    \"hold_time_option_prompt_seconds\":10,\n    \"onhold_prompt_no_block\":\"N\",\n    \"onhold_prompt_seconds\":10,\n    \"hold_time_second_option\":\"NONE\",\n    \"hold_time_third_option\":\"NONE\",\n    \"wait_hold_option_priority\":\"WAIT\",\n    \"wait_time_option\":\"NONE\",\n    \"wait_time_second_option\":\"NONE\",\n    \"wait_time_third_option\":\"NONE\",\n    \"wait_time_option_seconds\":120,\n    \"wait_time_option_exten\":\"8300\",\n    \"wait_time_option_voicemail\":\"\",\n    \"wait_time_option_xfer_group\":\"---NONE---\",\n    \"wait_time_option_callmenu\":\"\",\n    \"wait_time_option_callback_filename\":\"vm-hangup\",\n    \"wait_time_option_callback_list_id\":999,\n    \"wait_time_option_press_filename\":\"to-be-called-back|digits/1\",\n    \"wait_time_option_no_block\":\"N\",\n    \"wait_time_option_prompt_seconds\":10,\n    \"calculate_estimated_hold_seconds\":0,\n    \"na_call_url\":null,\n    \"group_calldate\":\"2024-07-08 14:40:12\",\n    \"drop_callmenu\":\"\",\n    \"after_hours_callmenu\":\"\",\n    \"user_group\":\"---ALL---\",\n    \"max_calls_method\":\"DISABLED\",\n    \"max_calls_count\":0,\n    \"max_calls_action\":\"NO_AGENT_NO_QUEUE\"\n}\n\n

Fields:

group_id: Inbound queue id getting updated.
\n
group_name: Inbound queue name.
\n
group_color: Inbound queue color.
\n
active: Y means inbound queue is active, else N.
\n
web_form_address: Web page that automatically displays on agent's screen when they get a call from that group. (optional)
\n
voicemail_ext: Extension calls are routd to when no agents are available. (optional)
\n
next_agent_call: Determines order in which calls are routed to available agents. Options are (longest_wait_time, random, inbound_group_rank, oldest_call_start, oldest_call_finish, oldest_inbound_call_start, oldest_inbound_call_finish, oldest_inbound_filtered_call_start, oldest_inbound_filtered_call_finish, overall_user_level, campaign_rank, ingroup_grade_random, campaign_grade_random, fewest_calls, fewest_calls_campaign, overall_user_level_wait_time, campaign_rank_wait_time, fewest_calls_wait_time, fewest_calls_campaign_wait_time, inbound_group_rank_wait_time).
\n
fronter_display: Y if fronter is shown to the closer or inbound agent, else N.
\n
ingroup_script: Incoming call script presented to an agent. (optional)
\n
get_call_launch: What displays on an agent's screen when an incoing call is delivered. Options are (NONE, SCRIPT, SCRIPTTWO, WEBFORM, WEBFORMTWO, WEBFORMTHREE, FORM, EMAIL).
\n
drop_call_seconds: Max amount of time a call will wait in the queue before a drop action is executed.
\n
drop_action: Options are (HANGUP, MESSAGE, VOICEMAIL, IN_GROUP, CALLMENU, VMAIL_NO_INST).
\n
drop_exten: The extension a dropped caller is routed to.
\n
call_time_id: Call times when inbound queue can receive calls.
\n
after_hours_action: Options are (HANGUP, MESSAGE, EXTENSION, VOICEMAIL, IN_GROUP, CALLMENU, VMAIL_NO_INST).
\n
after_hours_message_filename: Plays message to caller during designated after hours.
\n
after_hours_exten: Where incoming call are routed to during designated after hours.
\n
after_hours_voicemail: Voicemail for incoming calls during designated after hours. (optional)
\n
welcome_message_filename: Audio file played to a caller as a welcome message.
\n
moh_context: Dialplan context that is used for a caller who is placed on hold with music.
\n
onhold_prompt_filename: Audio file played when caller is on hold.
\n
prompt_interval: Frequency interval in seconds when onhold prompt is played.
\n
agent_alert_exten: Special extension to which an inbound call is routed before being sent to an agent.
\n
agent_alert_delay: Adds pause between when a call is sent to an agent and when the agent's web interface displays the call information.
\n
default_xfer_group: Destination queue to which calls are transferred by default.
\n
queue_priority: Determins order in which calls are retrieved. The lower the number the higher the priority.
\n
drop_inbound_group: Group id where abandoned inbounds calls are sent to.
\n
inbound_recording_override: Determines how call recording is handled for calls routed to that group. Options are (DISABLED, NEVER, ONDEMAND, ALLCALLS, ALLFORCE).
\n
ingroup_rec_filename: Naming convention for audio files.
\n
afterhours_xfer_group: Defines where to route call if it arrives outside the designated operating hours.
\n
play_place_in_line: Y/N.
\n
play_estimate_hold_time: Y/N.
\n
action_xfer_cid: Caller ID displayed to the agent while receiving a transfered call.
\n
extension_appended_cidname: Modify caller id's name to agent. Options are (Y, N, Y_USER, Y_WITH_CAMPAIGN, Y_USER_WITH_CAMPAIGN).
\n
hold_time_option: Alternative action a caller can take if wait time is longer than expected.
\n
hold_time_option_seconds: Wait time duration until action is triggered.
\n
hold_time_option_exten: Extension a caller will be sent to if their wait time exeeds its defined limit.
\n
hold_time_option_voicemail: Voicemail used when a caller's wait time exeeds its defined limit.
\n
hold_time_option_xfer_group: Group a caller will be sent to if their wait time exeeds its defined limit.
\n
hold_time_option_callback_filename: Audio file used when a caller's wait time exeeds its defined limit.
\n
hold_time_option_callback_list_id: List id a caller is saved to if their wait time exeeds its defined limit.
\n
hold_recall_xfer_group: Which group to route a held call to for a recall transfer.
\n
no_delay_call_route: Y/N.
\n
play_welcome_message: Options are (ALWAYS, NEVER, IF_WAIT_ONLY, YES_UNLESS_NODELAY)
\n
no_agent_no_queue: Options are (N, Y, NO_PAUSED, NO_READY).
\n
no_agent_action: Options are (CALLMENU, INGROUP, DID, MESSAGE, EXTENSION, VOICEMAIL, VMAIL_NO_INST).
\n
no_agent_action_value: Determines what happens to an inbound call when there are no agents logged in and ready to take the call.
\n
web_form_address_two: URL for second web form displayed to agent. (optional)
\n
start_call_url: External web url triggered when a call is successfully transfered to an agent. (optional)
\n
dispo_call_url: External web url triggered when an agent disposition's a call. (optional)
\n
ignore_list_script_override: Y/N.
\n
hold_time_option_minimum: Number of seconds a caller must be on hold until hold time option is executed.
\n
hold_time_option_press_filename: Audio file played when caller has been on hold for a specific amount of time.
\n
hold_time_option_callmenu: IVR call menu used when a caller has been on hold for a specific amount of time.
\n
hold_time_option_no_block: Y/N
\n
hold_time_option_prompt_seconds: How long on hold prompt audio message can play without blocking other calls in the queue.
\n
onhold_prompt_no_block: Y/N
\n
onhold_prompt_seconds: Time interval a periodic message is player to callers waiting in the queue.
\n
hold_time_second_option: Overflow option that is triggered after the hold time option seconds have been exceeded.
\n
hold_time_third_option: Overflow option that is triggered after the hold time option seconds have been exceeded for a third time.
\n
wait_time_option_priority: Options are (WAIT, HOLD, BOTH)
\n
wait_time_option: First action triggered after a caller has been waiting in the queue for a specified interval.
\n
wait_time_second_option: Second action triggered after a caller has been waiting in the queue for a specified interval.
\n
wait_time_third_option: Third action triggered after a caller has been waiting in the queue for a specified interval.
\n
wait_time_option_seconds: specifies the amount of time, in seconds, that an inbound caller must wait on hold before the special \"Wait Time Option\" is presented.
\n
wait_time_option_exten: specifies an extension for callers to use if they want to exit the waiting queue.
\n
wait_time_option_voicemail: Specifies the voicemail box where a caller is directed if they choose to leave the queue
\n
wait_time_option_xfer_group: Specifies a destination inbound group for a caller to be transferred to.
\n
wait_time_option_callmenu: Routes a waiting caller to a specific call menu after a predefined period.
\n
wait_time_option_callback_filename: The audio file that an inbound caller hears when they choose the option to receive a callback instead of continuing to wait on hold.
\n
wait_time_option_callback_list_id: List ID where a customer's call is placed when they opt for a callback while waiting in an inbound queue.
\n
wait_time_option_press_filename: Name of the sound file that is played to a caller after they have been on hold for a specified amount of time.
\n
wait_time_option_no_block: Y/N
\n
wait_time_option_prompt_seconds: Determines how long to wait before playing an audio prompt to a caller who is waiting in a queue.
\n
calculate_estimated_hold_seconds: Estimates the waiting time for an inbound call before it is connected to an agent.
\n
na_call_url: Executes a specified web address when a call is not connected to a live agent. (optional)
\n
group_calldate: Timestamp of a call associated with a specific agent's user group.
\n
drop_callmenu: Routing strategy used to handle dropped calls. (optional)
\n
after_hours_callmenu: Specifies which Call Menu to use when a call arrives outside of the defined business hours. (optional)
\n
user_group: Agent group id associated with inbound queue.
\n
max_calls_method: Options are (TOTAL, IN_QUEUE, DISABLED).
\n
max_calls_count: limits the number of concurrent calls that can be handled by agents assigned to that group.
\n
max_calls_action: Options are (DROP, AFTERHOURS, NO_AGENT_NO_QUEUE, AREACODE_FILTER).
\n

GET Delete Inbound Queue

https://ycc-api.ytel.com/api/v2/inbound-queue/delete?group_id=JB1

Delete inbound queue using its group_id.

\n","_postman_id":"b0e3e996-8216-4db6-80c3-651f209ee44e","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b6626842-49af-4640-b148-2c29843e1d6e","id":"b6626842-49af-4640-b148-2c29843e1d6e","name":"CCaaS API","type":"folder"}}},{"name":"YCC Voicemail","item":[{"name":"Get Voicemail","id":"658c857b-feec-42d0-8ddc-8316b7f23013","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"url":"https://ycc-api.ytel.com/api/v2/admin-utilities/get-voicemail/:id","urlObject":{"protocol":"https","path":["api","v2","admin-utilities","get-voicemail",":id"],"host":["ycc-api","ytel","com"],"query":[],"variable":[{"description":{"content":"

Voicemail id

\n","type":"text/plain"},"type":"any","value":"21225","key":"id"}]}},"response":[],"_postman_id":"658c857b-feec-42d0-8ddc-8316b7f23013"},{"name":"Delete Voicemail","id":"a8897850-11d3-46b9-8100-b240e5768c69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"url":"https://ycc-api.ytel.com/api/v2/admin-utilities/voicemail/delete?voicemail_id=vmid","urlObject":{"protocol":"https","path":["api","v2","admin-utilities","voicemail","delete"],"host":["ycc-api","ytel","com"],"query":[{"description":{"content":"

Voicemail id

\n","type":"text/plain"},"key":"voicemail_id","value":"vmid"}],"variable":[]}},"response":[],"_postman_id":"a8897850-11d3-46b9-8100-b240e5768c69"},{"name":"Create Voicemail","id":"3ec2c48b-02bb-4429-a87b-96566b9c1a00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"voicemail_id\":\"jbtest\",\n \"active\":\"Y\",\n \"pass\":\"yourpwd\",\n \"fullname\":\"Full Name\",\n \"messages\":0,\n \"old_messages\":0,\n \"email\":\"\",\n \"delete_vm_after_email\":\"N\",\n \"voicemail_timezone\":\"\",\n \"voicemail_options\":\"\",\n \"user_group\":\"---ALL---\",\n \"voicemail_greeting\":\"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/admin-utilities/add-new-voicemail","urlObject":{"protocol":"https","path":["api","v2","admin-utilities","add-new-voicemail"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ec2c48b-02bb-4429-a87b-96566b9c1a00"},{"name":"Update Voicemail","id":"73d398fb-74ac-4f48-99ff-92d6656e0851","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"voicemail_id\":\"jbtest\",\n \"active\":\"Y\",\n \"pass\":\"1234\",\n \"fullname\":\"Test Voicemail1\",\n \"messages\":4,\n \"old_messages\":0,\n \"email\":\"email@email.com\",\n \"delete_vm_after_email\":\"N\",\n \"voicemail_timezone\":\"pacific\",\n \"voicemail_options\":\"\",\n \"user_group\":\"---ALL---\",\n \"voicemail_greeting\":\"\",\n \"on_login_report\":\"Y\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/admin-utilities/update-voicemail","urlObject":{"protocol":"https","path":["api","v2","admin-utilities","update-voicemail"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"73d398fb-74ac-4f48-99ff-92d6656e0851"}],"id":"e075c4bc-164c-4601-9033-b19a69cb9ea7","description":"

YCC voicemail endpoints allow for creating, updating and viewing data about a voicemail.

Authorization: Bearer Token

This folder is using an authorization helper from folder CPaaS API.

Request Headers

Accept: application/json

Content-Type: application/json

GET Get Voicemail

https://ycc-api.ytel.com/api/v2/admin-utilities/get-voicemail/{id}

Get a voicemail's details. {id} is the voicemail id.

Fields within data:

voicemail_id: Voicemail id.
\n
active: Y if voicemail is active, else N.
\n
pass: Password.
\n
fullname: Name of voicemail.
\n
messages: Total pending messages.
\n
old_messages: Total messages listened to.
\n
email: Email recorded messages are sent to.
\n
delete_vm_after_email: Y if automatically delete voicemail after successfully sent to email, else N.
\n
voicemail_timezone: Timezone.
\n
voicemail_options: Specific settings for a voicemail box.
\n
user_group: Agent group associated with voicemail.
\n
voicemail_greeting: Pre-recorded message.
\n

POST Create Voicemail

https://ycc-api.ytel.com/api/v2/admin-utilities/add-new-voicemail

Create a new voicemail.

{\n    \"voicemail_id\":\"testvm\",\n    \"active\":\"Y\",\n    \"pass\":\"youpassword\",\n    \"fullname\":\"QA\",\n    \"messages\":0,\n    \"old_messages\":0,\n    \"email\":\"\",\n    \"delete_vm_after_email\":\"N\",\n    \"voicemail_timezone\":\"\",\n    \"voicemail_options\":\"\",\n    \"user_group\":\"---ALL---\",\n    \"voicemail_greeting\":\"\"\n}\n\n

Fields:

voicemail_id: Voicemail id.
\n
active: Y if voicemail is active, else N.
\n
pass: Password.
\n
fullname: Name of voicemail.
\n
messages: Total pending messages.
\n
old_messages: Total messages listened to.
\n
email: Email recorded messages are sent to.
\n
delete_vm_after_email: Y if automatically delete voicemail after successfully sent to email, else N.
\n
voicemail_timezone: Timezone.
\n
voicemail_options: Specific settings for a voicemail box. (nullable)
\n
user_group: Agent group associated with voicemail.
\n
voicemail_greeting: Pre-recorded message.
\n

POST Update Voicemail

https://ycc-api.ytel.com/api/v2/admin-utilities/update-voicemail

{\n    \"voicemail_id\":\"11111\",\n    \"active\":\"Y\",\n    \"pass\":\"password\",\n    \"fullname\":\"Test Voicemail1\",\n    \"messages\":4,\n    \"old_messages\":0,\n    \"email\":\"email@email.com\",\n    \"delete_vm_after_email\":\"N\",\n    \"voicemail_timezone\":\"pacific\",\n    \"voicemail_options\":\"\",\n    \"user_group\":\"---ALL---\",\n    \"voicemail_greeting\":\"\",\n    \"on_login_report\":\"N\"\n}\n\n

Fields:

voicemail_id: Voicemail id.
\n
active: Y if voicemail is active, else N.
\n
pass: Password.
\n
fullname: Name of voicemail.
\n
messages: Total pending messages.
\n
old_messages: Total messages listened to.
\n
email: Email recorded messages are sent to.
\n
delete_vm_after_email: Y if automatically delete voicemail after successfully sent to email, else N.
\n
voicemail_timezone: Timezone.
\n
voicemail_options: Specific settings for a voicemail box. (nullable)
\n
user_group: Agent group associated with voicemail.
\n
voicemail_greeting: Pre-recorded message.
\n
on_login_report: Y if using pre-built report, else N.
\n

POST Delete Voicemail

https://ycc-api.ytel.com/api/v2/admin-utilities/voicemail/delete?voicemail_id={voicemail_id}

Delete a voicemail by its id.

\n","_postman_id":"e075c4bc-164c-4601-9033-b19a69cb9ea7","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b6626842-49af-4640-b148-2c29843e1d6e","id":"b6626842-49af-4640-b148-2c29843e1d6e","name":"CCaaS API","type":"folder"}}},{"name":"YCC Number Management","item":[{"name":"Get Number","id":"56f3af47-378d-4c88-8d90-596ab01f6c0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"url":"https://ycc-api.ytel.com/api/v2/number-edit/12223334444","urlObject":{"protocol":"https","path":["api","v2","number-edit","12223334444"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"56f3af47-378d-4c88-8d90-596ab01f6c0e"},{"name":"Number Update","id":"cf055168-621c-4a59-b445-ef050f02efe1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"did_pattern\":\"12223334444\",\n \"user_callback_queue_default_return\":\"\",\n \"did_description\":\"ACCID - 1 Per State\",\n \"did_active\":\"N\",\n \"record_call\":\"N\",\n \"did_route\":\"IN_GROUP\",\n \"extension\":\"\",\n \"voicemail_ext\":\"\",\n \"phone\":\"\",\n \"menu_id\":\"\",\n \"user_from_universe\":\"\",\n \"list_id\":\"999\",\n \"group_id\":\"Callbacks\",\n \"call_handle_method\":\"CIDLOOKUP\",\n \"campaign_id\":\"\",\n \"filter_inbound_number\":\"GROUP\",\n \"filter_phone_group_id\":\"blacklist\",\n \"filter_url\":\"\",\n \"filter_action\":\"EXTEN\",\n \"filter_user\":\"\",\n \"filter_extension\":\"9998887777\",\n \"filter_voicemail_ext\":\"\",\n \"filter_menu_id\":\"\",\n \"filter_list_id\":\"\",\n \"filter_group_id\":\"---NONE---\",\n \"filter_call_handle_method\":\"CID\",\n \"filter_dnc_campaign\":\"\",\n \"filter_phone\":\"\",\n \"filter_exten_context\":\"default\",\n \"filter_url_did_redirect\":\"N\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://ycc-api-dev.ytel.com/api/number-update","urlObject":{"protocol":"https","path":["api","number-update"],"host":["ycc-api-dev","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf055168-621c-4a59-b445-ef050f02efe1"}],"id":"c1369840-7663-4a56-9a7a-6a93fb35ab49","description":"

YCC number management endpoints allow for updating and viewing number data.

Authorization: Bearer Token

This folder is using an authorization helper from folder CPaaS API.

Request Headers

Accept: application/json

Content-Type: application/json

GET Number

https://ycc-api.ytel.com/api/v2/number-edit/12068487626

Gets a number's details.

Response Fields:

data: Contains number details.
\n
callback_queue_url: Contains details for callback.
\n
number_set_id: Number set id.
\n

Fields within data:

did_id: Internal DID id.
\n
did_patten: Number.
\n
did_description: Description of DID.
\n
did_active: Y means did is active, else N.
\n
did_route: Determines where incoming traffic is routed to.
\n
extension: Number extension.
\n
exten_context: Refers to the specific dialplan context in the underlying Asterisk phone system where a phone or extension will start its call routing.
\n
voicemail_ext: Voicemail extension.
\n
phone: Phone enabling agent to receive incoming calls from the public telephone network.
\n
server_ip: Server ip.
\n
user: User id.
\n
user_unavailable_action: Destination set when user is unavailable.
\n
user_route_settings_ingroup: Used for agent direct calls. Default value is AGENTDIRECT.
\n
group_id: Inbound group id.
\n
call_handle_method: Determines how incoming calls are processed and matched with a lead.
\n
agent_search_method: Setting that determines how the system handles lead searching when an agent uses the manual dial feature.
\n
list_id: List id.
\n
campaign_id: Campaign id.
\n
phone_code: Number country code.
\n
menu_id: Menu id.
\n
record_call: Y if recording calls is enabled, else N.
\n
filter_inbound_number: Defines how to filter inbound calls.
\n
filter_phone_group_id: Filter group id that is assigned to this number.
\n
filter_url: Web url that an incoming caller's information is sent to in order to determine how to route or handle the call.
\n
filter_action: Filter action that is assigned to this number.
\n
filter_extension: Filter extension that is assigned to this number.
\n
filter_voicemail_ext: Filter voicemail that is assigned to this number.
\n
filter_phone: Filter phone that is assigned to this number.
\n
filter_server_ip: Filter server ip that is assigned to this number.
\n
filter_user: Filter user that is assigned to this number.
\n
filter_user_unavailable_action: Action taken when an inbound call is directed to a specific user who is unavailable.
\n
filter_user_route_settings_ingroup: Settings determine which agents are eligible to receive inbound calls from that specific group.
\n
filter_group_id: Filter group id that is assigned to this number.
\n
filter_call_handle_method: Rules and logic that determine which leads are dialed and when, as well as how inbound calls are handled.
\n
filter_agent_search_method: Determines the scope the agent can search manually when looking up a lead.
\n
filter_list_id: Filter list id that is assigned to this number.
\n
filter_campaign_id: Filter campaign id that is assigned to this number.
\n
filter_phone_code: Filter phone code that is assigned to this number.
\n
filter_menu_id: Filter menu id that is assigned to this number.
\n
filter_clean_cid_number: Modifies the caller ids of incoming calls by stripping leading digits.
\n
custom_one: Custom field storing specific information about the number.
\n
custom_two: Custom field storing specific information about the number.
\n
custom_three: Custom field storing specific information about the number.
\n
custom_four: Custom field storing specific information about the number.
\n
custom_five: Custom field storing specific information about the number.
\n
user_group: The user group the number is assigned to.
\n
filter_dnc_campaign: Filter out incoming
\n
filter_url_did_redirect: Y if filter url did redirect is active, N if inactive.
\n
no_agent_ingroup_redirect: Options are (DISABLED, Y, NO_PAUSED, READY_ONLY).
\n
no_agent_ingroup_id: Specific inbound group that calls are transferred to when there are no agents available.
\n
no_agent_ingroup_extension: The extension an inbound call is routed to when there are no agents available for a specific ingroup.
\n
pre_filter_phone_group_id: Pre filter group id that is assigned to this number.
\n
pre_filter_extension: Pre filter extension that is assigned to this number.
\n
entry_list_id: Entry list id of a lead's custom fields.
\n
filter_entry_list_id: Filter entry list id that is assigned to this number.
\n
max_queue_ingroup_calls: Maximum number of calls allowed to in queue for a specific inbound group at any given time.
\n
max_queue_ingroup_id: In-Group ID to which calls are routed to if they exceed the maximum capacity defined for a specific inbound campaign.
\n
max_queue_ingroup_extension: Specific extension executed when the maximum queue size for an inbound group has been reached.
\n
inbound_route_answer: Y if inbound route answer is active, N if inactive.
\n
pre_filter_recent_call: Automatically disables a campaign or call if a specific caller ID is detected within a short timeframe.
\n
pre_filter_recent_extension: Manages incoming calls based on the caller's recent call history.
\n
modify_stamp: Date time number was last modified.
\n

Fields within callback_queue_url:

user_callback_queue_default_return:

POST Number Update

https://ycc-api.ytel.com/api/v2/number-update

Update a number's details.

{\n   \"did_pattern\":\"12223334444\",\n   \"user_callback_queue_default_return\":\"\",\n   \"did_description\":\"ACCID - 1 Per State\",\n   \"did_active\":\"N\",\n   \"record_call\":\"N\",\n   \"did_route\":\"IN_GROUP\",\n   \"extension\":\"\",\n   \"voicemail_ext\":\"\",\n   \"phone\":\"\",\n   \"menu_id\":\"\",\n   \"user_from_universe\":\"\",\n   \"list_id\":\"999\",\n   \"group_id\":\"Callbacks\",\n   \"call_handle_method\":\"CIDLOOKUP\",\n   \"campaign_id\":\"\",\n   \"filter_inbound_number\":\"GROUP\",\n   \"filter_phone_group_id\":\"blacklist\",\n   \"filter_url\":\"\",\n   \"filter_action\":\"EXTEN\",\n   \"filter_user\":\"\",\n   \"filter_extension\":\"9998881111\",\n   \"filter_voicemail_ext\":\"\",\n   \"filter_menu_id\":\"\",\n   \"filter_list_id\":\"\",\n   \"filter_group_id\":\"---NONE---\",\n   \"filter_call_handle_method\":\"CID\",\n   \"filter_dnc_campaign\":\"\",\n   \"filter_phone\":\"\",\n   \"filter_exten_context\":\"default\",\n   \"filter_url_did_redirect\":\"N\"\n}\n\n

Fields:

did_pattern: The number that is getting updated.
\n
user_callback_queue_default_return: specifies the destination for a callback queue entry if the originally assigned agent does not become available. (optional)
\n
did_description: Description for number.
\n
did_active: Y means number is active, N otherwise.
\n
record_call: Y if calls get recorded, N otherwise.
\n
did_route: Specifies how incoming call is handled. Options are (EXTEN, VOICEMAIL, AGENT, PHONE, IN_GROUP, CALLMENU, VMAIL_NO_INST).
\n
extension: Number extension. (optional)
\n
voicemail_ext: Voicemail extension. (optional)
\n
phone: Phone enabling agent to receive incoming calls from the public telephone network. (optional)
\n
menu_id: Call menu id that presents callers with a pre-recorded menu of options for directing their calls. (optional)
\n
user_from_universe: Internal field.
\n
list_id: The list_id of the defined group of leads for outbound calling campaigns.
\n
group_id: Inbound group id.
\n
call_handle_method: Specifies how an inbound call should be processed when it is routed to an In-Group**.**
\n
campaign_id: Campaign id. (optional)
\n
filter_inbound_number: How to filter inbound calls. Options are (DISABLED, GROUP, URL, DNC_INTERNAL, DNC_CAMPAIGN, GROUP_AREACODE).
\n
filter_phone_group_id: Filter phone group id that is assigned to this number.
\n
filter_url: Web url that an incoming caller's information is sent to in order to determine how to route or handle the call. (optional)
\n
filter_action: Filter action number is set to. Options are (EXTEN, VOICEMAIL, AGENT, PHONE, IN_GROUP, CALLMENU, VMAIL_NO_INST).
\n
filter_user: Filter user that is assigned to number. (optional)
\n
filter_extension: Filter extension that is assigned to this number.
\n
filter_voicemail_ext: Filter voicemail id that is assigned to this number. (optional)
\n
filter_menu_id: Filter menu id that is assigned to this number. (optional)
\n
filter_list_id: Filter list_id that is assigned to this number. (optional)
\n
filter_group_id: Filter group id that is assigned to this number.
\n
filter_call_handled_method: setting that specifies how the call should be routed if its Caller ID matches a filter.
\n
filter_dnc_campaign: Filter out incoming calls on campaign specific dnc list. (optional)
\n
filter_phone: Filter phone that is assigned to this number. (optional)
\n
filter_exten_context: Dialplan context that an incoming call will be sent to if its caller id matches a number.
\n
filter_url_did_redirect: Y to enable filter_url, N otherwise.
\n

\n","_postman_id":"c1369840-7663-4a56-9a7a-6a93fb35ab49","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b6626842-49af-4640-b148-2c29843e1d6e","id":"b6626842-49af-4640-b148-2c29843e1d6e","name":"CCaaS API","type":"folder"}}},{"name":"YCC Agent Management","item":[{"name":"Get Agent List","id":"cae34dba-cf8b-4b4b-9787-5c7214a31d95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"url":"https://ycc-api.ytel.com/api/v2/get-agent-list","urlObject":{"protocol":"https","path":["api","v2","get-agent-list"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cae34dba-cf8b-4b4b-9787-5c7214a31d95"},{"name":"Get Agent Details","id":"c57fed88-592d-4756-a180-f865b5675438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"url":"https://ycc-api.ytel.com/api/v2/agent-details?id=1010","urlObject":{"protocol":"https","path":["api","v2","agent-details"],"host":["ycc-api","ytel","com"],"query":[{"key":"id","value":"1010"}],"variable":[]}},"response":[],"_postman_id":"c57fed88-592d-4756-a180-f865b5675438"},{"name":"Clone Agent","id":"54dc038e-7ba2-4656-b6f8-604cee9b415b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"from_agent\":\"1984\",\n \"full_name\":\"Agent Name\",\n \"new_agent\":\"5150\",\n \"pass\":\"YOURpassword1234\",\n \"email\":\"newagentemail@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/clone-agent-details","urlObject":{"protocol":"https","path":["api","v2","clone-agent-details"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"54dc038e-7ba2-4656-b6f8-604cee9b415b"},{"name":"Update Agent Details","id":"cf49a30f-fea3-49ac-a6c5-8f43c285d348","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"email\":\"agentemail@email.com\",\n \"new_email\":null,\n \"full_name\":\"John Doe\",\n \"name\":\"1050\",\n \"user_group\":\"AGENTSGROUP\",\n \"pass\":null,\n \"active\":\"Y\",\n \"agent_choose_ingroups\":\"0\",\n \"agentcall_manual\":\"1\",\n \"agentonly_callbacks\":\"1\",\n \"closer_default_blended\":\"1\",\n \"voicemail_id\":\"9999\",\n \"custom_one\":null,\n \"custom_two\":null,\n \"custom_three\":null,\n \"custom_four\":null,\n \"custom_five\":null,\n \"force_change_password\":\"N\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/update-agent-details","urlObject":{"protocol":"https","path":["api","v2","update-agent-details"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf49a30f-fea3-49ac-a6c5-8f43c285d348"},{"name":"Get Agent's Inbound Groups","id":"21fdd5b7-e1c1-4573-adde-0389471edabc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"email\":\"agentemail@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/agent-inbound-groups","urlObject":{"protocol":"https","path":["api","v2","agent-inbound-groups"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"21fdd5b7-e1c1-4573-adde-0389471edabc"},{"name":"Update Agent's Inbound Groups","id":"bac76086-dbf1-4440-8f95-ffa4b12662a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"email\":\"agentemail@email.com\",\n \"inbound_array\": [\n {\n \"group_name_values\": \"Single Agent Direct Queue2\",\n \"group_id_values\": \"AGENTDIRECT\",\n \"group_rank\": 0,\n \"group_grade\": 1,\n \"calls_today\": 0,\n \"group_web_vars\": \"\",\n \"status\": 0,\n \"daily_limit\": -1,\n \"UpdateRow\": 0\n },\n {\n \"group_name_values\": \"Agent Direct Queue for Chats\",\n \"group_id_values\": \"AGENTDIRECT_CHAT\",\n \"group_rank\": 0,\n \"group_grade\": 1,\n \"calls_today\": 0,\n \"group_web_vars\": \"\",\n \"status\": 0,\n \"daily_limit\": -1,\n \"UpdateRow\": 0\n },\n {\n \"group_name_values\": \"Callbacks InBound\",\n \"group_id_values\": \"Callbacks\",\n \"group_rank\": 0,\n \"group_grade\": 1,\n \"calls_today\": 0,\n \"group_web_vars\": \"\",\n \"status\": 0,\n \"daily_limit\": -1,\n \"UpdateRow\": 0\n },\n {\n \"group_name_values\": \"JB TEST1\",\n \"group_id_values\": \"JBTEST\",\n \"group_rank\": 0,\n \"group_grade\": 1,\n \"calls_today\": 0,\n \"group_web_vars\": \"\",\n \"status\": 0,\n \"daily_limit\": -1,\n \"UpdateRow\": 0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/update-agent-inbound-groups","urlObject":{"protocol":"https","path":["api","v2","update-agent-inbound-groups"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bac76086-dbf1-4440-8f95-ffa4b12662a8"},{"name":"Delete Agent","id":"0cbc74b0-9ec7-4d82-9ebb-ff67c5b4392e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"url":"https://ycc-api.ytel.com/api/v2/delete-agent?user_id=1050","urlObject":{"protocol":"https","path":["api","v2","delete-agent"],"host":["ycc-api","ytel","com"],"query":[{"description":{"content":"

Id of the agent to be deleted

\n","type":"text/plain"},"key":"user_id","value":"1050"}],"variable":[]}},"response":[],"_postman_id":"0cbc74b0-9ec7-4d82-9ebb-ff67c5b4392e"},{"name":"Get Agent Groups List","id":"4ee8936b-6fdc-4532-a555-2fe276c18dd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"url":"https://ycc-api.ytel.com/api/v2/agentgroup-lists?limit=100000&page=1","urlObject":{"protocol":"https","path":["api","v2","agentgroup-lists"],"host":["ycc-api","ytel","com"],"query":[{"key":"limit","value":"100000"},{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"4ee8936b-6fdc-4532-a555-2fe276c18dd8"},{"name":"Get Agent Group","id":"c4a1fab1-928e-4eae-9e1d-c48607b99cc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"url":"https://ycc-api-dev.ytel.com/api/v2/agent-group-edit?user_group=TESTGROUP","urlObject":{"protocol":"https","path":["api","v2","agent-group-edit"],"host":["ycc-api-dev","ytel","com"],"query":[{"description":{"content":"

Agent group id

\n","type":"text/plain"},"key":"user_group","value":"TESTGROUP"}],"variable":[]}},"response":[],"_postman_id":"c4a1fab1-928e-4eae-9e1d-c48607b99cc7"},{"name":"Update Agent Group","id":"b3d587cd-7e27-4463-baac-eaefaa1fe3eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"user_group\": \"TESTGROUP\",\n \"agent_call_log_view\":\"N\",\n \"agent_status_view_time\":\"N\",\n \"agent_status_viewable_groups\":[\"\",\"--ALL-GROUPS--\",\"\",\"\"],\n \"allowed_campaigns\":[\"-ALL-CAMPAIGNS-\"],\n \"forced_timeclock_login\":\"N\",\n \"group_name\":\"testgroup1\",\n \"group_shifts\":\" \",\n \"shift_enforcement\":\"OFF\",\n \"agent_xfer_consultative\":\"N\",\n \"agent_xfer_vm_transfer\":\"N\",\n \"agent_xfer_blind_transfer\":\"N\",\n \"agent_xfer_dial_with_customer\":\"N\",\n \"agent_xfer_park_customer_dial\":\"N\",\n \"hide_take_call_in_queue\":\"N\",\n \"hide_number_take_call_in_queue\":\"N\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ycc-api-dev.ytel.com/api/v2/agentgroup-edit","urlObject":{"protocol":"https","path":["api","v2","agentgroup-edit"],"host":["ycc-api-dev","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3d587cd-7e27-4463-baac-eaefaa1fe3eb"},{"name":"Clone Agent Group","id":"691dc7f4-0b38-4f3d-b82a-cfdc6722b893","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"from_user_group\":\"ADMIN\",\n \"user_group\":\"TestGroup25\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/agentgroup-clone","urlObject":{"protocol":"https","path":["api","v2","agentgroup-clone"],"host":["ycc-api","ytel","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"691dc7f4-0b38-4f3d-b82a-cfdc6722b893"},{"name":"Delete Agent Group","id":"1ad0a095-a7f7-4294-8bd8-3bb6c2bff0cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {Your Authentication Token}","description":"

Generated using the CPaaS API.

\n"}],"body":{"mode":"raw","raw":"{\n \"from_user_group\":\"ADMIN\",\n \"user_group\":\"TestGroup\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ycc-api.ytel.com/api/v2/agentgroup-delete?user_id=TestGroup25","urlObject":{"protocol":"https","path":["api","v2","agentgroup-delete"],"host":["ycc-api","ytel","com"],"query":[{"description":{"content":"

Id of agent group getting deleted.

\n","type":"text/plain"},"key":"user_id","value":"TestGroup25"}],"variable":[]}},"response":[],"_postman_id":"1ad0a095-a7f7-4294-8bd8-3bb6c2bff0cc"}],"id":"1feb311d-5c03-428b-a9a6-9047177a4928","description":"

YCC agent management endpoints allow for cloning, updating, deleting and viewing data about an agent.

Authorization: Bearer Token

This folder is using an authorization helper from folder CPaaS API.

Request Headers

Accept: application/json

Content-Type: application/json

GET Get Agent List

https://ycc-api.ytel.com/api/v2/get-agent-list

Get a list of agents.

data: List of agents.

Fields within data:

user: User id.
\n
full_name: Name of user.
\n

GET Get Agent Details

https://ycc-api.ytel.com/api/v2/agent-detailst?id={id}

Get an agent's details by its id.

Fields:

user_info: Contains user details.
\n
manual_dial_cid: Contains outbound caller id.
\n
admin_user_group_list: List of user groups.
\n
voicemail: List of voicemail ids.
\n
dids: List of DIDs.
\n

Fields within user_info:

user: User id.
\n
full_name: Full name of user.
\n
user_group: User group id.
\n
agent_choose_ingroups: 1 if an agent can manually select which inbound groups they could receive calls from else 0.
\n
closer_campaigns: List of closer campaign ids. (inbound queues)
\n
scheduled_callbacks: 1 if an agent can schedule callbacks, 0 if not.
\n
agentonly_callbacks: 1 if only this agent can receive a callback lead, 0 if callback lead goes to the next available agent.
\n
agentcall_manual: 1 if agent is able to place manual calls else 0 if they are not.
\n
closer_default_blended: 1 if an agent will be in blended mode upon login else 0 if they are not.
\n
active: Y if active, N if not active.
\n
email: User email.
\n
custom_one: Custom field storing specific information about the agent.
\n
custom_two: Custom field storing specific information about the agent.
\n
custom_three: Custom field storing specific information about the agent.
\n
custom_four: Custom field storing specific information about the agent.
\n
custom_five: Custom field storing specific information about the agent.
\n
voicemail_id: Voicemail id.
\n
agent_call_log_view_override: Override permissions set for user group to view call logs. The options are DISABLED, Y, N.
\n
force_change_password: Y if the user is required to change their password the next time they login, N if they are not required to.
\n
agent_lead_search_override: Allows agents to search for and modify leads outside of the lead they are currently calling. The options are NOT_ACTIVE, ENABLED, LIVE_CALL_INBOUND, LIVE_CALL_INBOUND_AND_MANUAL, DISABLED.
\n
failed_login_count: Total failed user login attempts.
\n
last_login_date: Last date time user logged in.
\n
last_ip: The last IP the user was using.
\n
modify_stamp: Last date time user details were modified.
\n

Fields within manua_dial_cid:

outbound_cid: Outbound caller id.

Fields within admin_user_group_list:

user_group: User group id.
\n
group_name: User group name.
\n

Fields within voicemail:

voicemail_id: Voicemail unique id.
\n
fullname: Voicemail name.
\n
email: Email address.
\n

Fields within dids:

did_pattern: Did.
\n
option_title: Did description.
\n

POST Clone Agent

https://ycc-api.ytel.com/api/v2/clone-agent-details

Clone an agent.

{\n    \"from_agent\":\"9999\",\n    \"full_name\":\"Full Name\",\n    \"new_agent\":\"1076\",\n    \"pass\":\"password\",\n    \"email\":\"email@email.com\"\n}\n\n

Fields:

from_agent: Agent user id being cloned.
\n
full_name: Name of new agent.
\n
new_agent: User id of new agent.
\n
pass: Password.
\n
email: Email for new agent.
\n

POST Update Agent Details

https://ycc-api.ytel.com/api/v2/update-agent-details

{\n    \"email\":\"email@email.com\",\n    \"new_email\":null,\n    \"full_name\":\"fullname\",\n    \"name\":\"9999\",\n    \"user_group\":\"AGENTS\",\n    \"pass\":\"\",\n    \"active\":\"Y\",\n    \"agent_choose_ingroups\":\"0\",\n    \"agentcall_manual\":\"1\",\n    \"agentonly_callbacks\":\"1\",\n    \"closer_default_blended\":\"1\",\n    \"voicemail_id\":\"9999\",\n    \"custom_one\":null,\n    \"custom_two\":null,\n    \"custom_three\":null,\n    \"custom_four\":null,\n    \"custom_five\":null,\n    \"force_change_password\":\"N\"\n}\n\n

Fields:

email: user email.
\n
new_email: new user email. (optional)
\n
full_name: full_name of user.
\n
name: new user id of agent.
\n
user_group: user group id.
\n
pass: admin password is required if resetting the user's email.
\n
active: Y if active, N if not active.
\n
agent_choose_ingroups: 1 if an agent can manually select which inbound groups they would receive calls from else 0.
\n
agentcall_manual: 1 if an agent can manually dial a phone number else 0 they must rely on the automated dialer to pull a lead.
\n
agentonly_callbacks: 1 if only this agent can receive a callback lead, 0 if callback lead goes to the next available agent.
\n
closer_default_blended: 1 if an agent will be in blended mode upon login else 0 if they are not.
\n
voicemail_id: voicemail id.
\n
custom_one: Custom field storing specific information about the agent. (optional)
\n
custom_two: Custom field storing specific information about the agent. (optional)
\n
custom_three: Custom field storing specific information about the agent. (optional)
\n
custom_four: Custom field storing specific information about the agent. (optional)
\n
custom_five: Custom field storing specific information about the agent. (optional)
\n
force_change_password: Y to require the user to change their password every time they login, N if they are not required to.
\n

POST Delete Agent

https://ycc-api.ytel.com/api/v2/delete-agent?user_id={user_id}

Delete an agent by its id.

GET Get Agent Groups List

https://ycc-api.ytel.com/api/v2/agentgroup-lists?limit=100000&page=1

Get a list of agent groups.

data: List of agent groups.

Fields within data:

user_group: User group id.
\n
group_name: Name of user group.
\n

GET Get Agent Group

https://ycc-api.ytel.com/api/v2/agent-group-edit?user_group={user_group_id}

Get an agent group's details by its id.

Fields: within data:

group_info: Contains agent group info.
\n
campaign: Contains list of campaigns associated with agent group.
\n

Fields within group_info:

user_group: Agent group id.
\n
group_name: Agent group name.
\n
allowed_campaigns: List of campaigns an agent can view and interact with.
\n
qc_allowed_campaigns: Determins which campaigns a user within this group is permitted to perform Quality Control reviews for.
\n
qc_allowed_inbound_groups: Restricts which inbound call groups a user can review in the Quality Control module.
\n
group_shifts: List of pre-configured time shifts that restrict when a user can login.
\n
forced_timeclock_login: Y if an user is forced to perform a timeclock login, else N.
\n
shift_enforcement: Options are (OFF, START, ALL). OFF disables, START enforces start time, ALL enforces start and end time shift restrictions.
\n
agent_status_viewable_groups: Array of groups that determins which other users an agent can see the real-time status of.
\n
agent_status_view_time: Y if agents can see the duration of the current status for other agents in their sidebar, else N.
\n
agent_call_log_view: Y if agents can see there own call history, else N.
\n
agent_xfer_consultive: Y if there is a warm agent transfer, else N.
\n
agent_xfer_dial_override:
\n
agent_xfer_vm_transfer: Y if the agent has the ability to transfer an active call to a pre-recorded message, else N.
\n
agent_xfer_blind_transfer: Y if the agent has the ability to transfer a customer directly to an external number, else N.
\n
agent_xfer_dial_with_customer: Y if agent is allowed to make a three-way conference call, else N.
\n
agent_xfer_park_customer_dial: Y if agent is allowed to put the customer on hold, else N.
\n
agent_fullscreen: Y forces the agent's screen to fil the entire browser window, else N.
\n
allowed_reports: Lists which report a user in this group can view.
\n
webphone_url_override: Custom webphone url.
\n
webphone_systemkey_override: Setting that allows user to override the Webphone System key.
\n
webphone_dialpad_override: Enable or diable the ability for agents to manually dial numbers.
\n
admin_viewable_groups: Determines what other agents groups can be seen.
\n
admin_viewable_call_times: Determines which Call Time Presets a user can see and assign to campaigns.
\n
allowed_custom_reports: Determines access to custom reports.
\n
agent_allowed_chat_groups: Determines which agents a user can see and intiate internal chats with.
\n
agent_xfer_park_3way: Determine ability of agent to park a customer on a 3-way conference call.
\n
admin_ip_list: Restricts access to certain web resources based on ip.
\n
webphone_layout: Controls appearance and functionality of WebRTC phone.
\n
allowed_queue_groups: Controls which user groups can have visibility and admin privileges over other user groups. (nullable)
\n
reports_header_override: Allows used to define a custom header for reports.
\n
admin_home_url: Home link.
\n
script_id: Script id.
\n
modify_stamp: Last date time agent group details were modified.
\n
hide_take_call_in_queue: Y if agents cannot see the queue, else N.
\n
hide_number_take_call_in_queue: Y if agent cannot see a customer's phone number, else N.
\n

Fields within campaign:

campaign_id: Campaign id.
\n
campaign_name: Campaign name.
\n

POST Clone Agent Group

https://ycc-api.ytel.com/api/v2/agentgroup-clone

Clone an agent group.

{\n    \"from_user_group\":\"ADMIN\",\n    \"user_group\":\"TestGroup\"\n}\n\n

Fields:

from_user_group: Agent group id being cloned.
\n
user_group: New agent group id.
\n

POST Update Agent Group

https://ycc-api.ytel.com/api/v2/agentgroup-edit

{\n    \"user_group\":\"ADMIN\", \n    \"agent_call_log_view\":false,\n    \"agent_status_view_time\":false,\n    \"agent_status_viewable_groups\":[\"\",\"--ALL-GROUPS--\",\"\",\"\"],\n    \"allowed_campaigns\":[\"-ALL-CAMPAIGNS-\"],\n    \"forced_timeclock_login\":\"N\",\n    \"group_name\":\"administrators\",\n    \"group_shifts\":\"  \",\n    \"shift_enforcement\":\"OFF\",\n    \"agent_xfer_consultative\":true,\n    \"agent_xfer_vm_transfer\":true,\n    \"agent_xfer_blind_transfer\":true,\n    \"agent_xfer_dial_with_customer\":true,\n    \"agent_xfer_park_customer_dial\":true,\n    \"hide_take_call_in_queue\":false,\n    \"hide_number_take_call_in_queue\":false\n}\n\n

Fields:

user_group: Agent group id.
\n
agent_call_log_view: Y if agents can see there own call history, else N.
\n
agent_status_view_time: Y if agents can see the duration of the current status for other agents in their sidebar, else N.
\n
agent_status_viewable_groups: Array of groups that determins which other users an agent can see the real-time status of.
\n
allowed_campaigns: List of campaigns an agent can view and interact with.
\n
forced_timeclock_login: Y if a user is forced to perform a timeclock login, else N.
\n
group_name: Name of agent group.
\n
group_shifts: List of pre-configured time shifts that restrict when a user can login.
\n
shift_enforcement: Options are (OFF, START, ALL). OFF disables, START enforces start time, ALL enforces start and end time shift restrictions.
\n
agent_xfer_consultive: Y if there is a warm agent transfer, else N.
\n
agent_xfer_vm_transfer: Y if the agent has the ability to transfer an active call to a pre-recorded message, else N.
\n
agent_xfer_blind_transfer: Y if the agent has the ability to transfer a customer directly to an external number, else N.
\n
agent_xfer_dial_with_customer: Y if agent is allowed to make a three-way conference call, else N.
\n
agent_xfer_park_customer_dial: Y if agent is allowed to put the customer on hold, else N.
\n
hide_take_call_in_queue: Y if agents cannot see the queue, else N.
\n
hide_number_take_call_in_queue: Y if agent cannot see a customer's phone number, else N.
\n

POST Delete Agent Group

https://ycc-api.ytel.com/api/v2/agentgroup-delete?user_id={user_group_id}

Delete an agent group by its id.

POST Get Agent's Inbound Groups

https://ycc-api.ytel.com/api/v2/agent-inbound-groups

Get a list of inbound groups for an agent.

{\n    \"email\":\"agentemail@email.com\"\n}\n\n

Submitted Fields:

email: Email of agent.

Response Fields:

data: List of agent groups.

Fields within data:

group_name_values: Group name.
\n
group_id_values: Group id.
\n
group_rank: The higher the grade the higher the priority the Agent has within the group.
\n
group_grade: The higher the grade the higher the group priority for inbound calls between multiple ingroups.
\n
calls_today: Total number of inbound calls answered by group.
\n
group_web_vars: Custom variables you can define and send to an external web page when a call is handled. (nullable)
\n
status: Internal field. (nullable)
\n
daily_limit: Maximum number of inbound calls an agent can handle in that day.
\n
updateRow: 1 to update row else 0.
\n

POST Update Agent's Inbound Groups

https://ycc-api.ytel.com/api/v2/update-agent-inbound-groups

Update a list of inbound groups for an agent.

{\n    \"email\":\"agentemail@email.com\",\n    \"inbound_array\": [ \n        {\n            \"group_id_values\":\"AGENTDIRECT\",\n            \"group_rank\":0,\n            \"group_grade\":1,\n            \"calls_today\":0,\n            \"group_web_vars\":\"\",\n            \"status\":false,\n            \"daily_limit\":\"-1\",\n            \"UpdateRow\":1\n        },\n        {\n            \"group_id_values\":\"AGENTDIRECT_CHAT\",\n            \"group_rank\":0,\n            \"group_grade\":1,\n            \"calls_today\":0,\n            \"group_web_vars\":\"\",\n            \"status\":0,\n            \"daily_limit\":-1,\n            \"UpdateRow\":0\n        },\n        {\n            \"group_id_values\":\"Callbacks\",\n            \"group_rank\":0,\n            \"group_grade\":1,\n            \"calls_today\":0,\n            \"group_web_vars\":\"\",\n            \"status\":0,\n            \"daily_limit\":-1,\n            \"UpdateRow\":0\n        },\n        {\n            \"group_id_values\":\"JBTEST\",\n            \"group_rank\":0,\n            \"group_grade\":1,\n            \"calls_today\":0,\n            \"group_web_vars\":\"\",\n            \"status\":0,\n            \"daily_limit\":-1,\n            \"UpdateRow\":0\n        }\n    ]\n}\n\n

Fields:

email: Email of agent getting updated.
\n
inbound_array: List of groups getting updatind.
\n

Fields within each group:

group_id_values: Group id.
\n
group_rank: The higher the grade the higher the priority the Agent has within the group.
\n
group_grade: The higher the grade the higher the group priority for inbound calls between multiple ingroups.
\n
calls_today: Total number of inbound calls answered by group.
\n
group_web_vars: Custom variables you can define and send to an external web page when a call is handled. (nullable)
\n
status: 1 if applying group_web_vars else 0.
\n
daily_limit: Maximum number of inbound calls an agent can handle in that day.
\n
updateRow: 1 to apply update to this row else 0.
\n

\n","_postman_id":"1feb311d-5c03-428b-a9a6-9047177a4928","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"b6626842-49af-4640-b148-2c29843e1d6e","id":"b6626842-49af-4640-b148-2c29843e1d6e","name":"CCaaS API","type":"folder"}}}],"id":"b6626842-49af-4640-b148-2c29843e1d6e","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"88bfd340-a9dd-457b-b454-76401a60df83"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b8fb4332-7670-4d44-8d7c-8907d3e6f3b7"}}],"_postman_id":"b6626842-49af-4640-b148-2c29843e1d6e","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2ebed099-144f-461d-897e-f2e3a6d669f7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"c01c8176-db84-4d4f-a77f-7d0967ee49d7"}}],"variable":[{"id":"192f31e3-b3fd-4378-8700-80df50ef3f3f","key":"ivr_name","value":"my-ivr"}]}