{"info":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"20206958","collectionId":"c575e410-8aeb-4ac5-9390-ae2b20766c95","publishedId":"2sAXjT1Uoa","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-09-10T14:53:10.000Z"},"item":[{"name":"Getting Started","item":[],"id":"a489f519-eb19-4c6f-b66d-d8f791914353","description":"

Authentication

Every API request requires authentication which you will need to create your tokens in the customer portal https://commio.io

Tokens now have a single management location in addition to granular access capabilities, enabling customers to use the same or individual tokens for each of the operations they perform.

Login to the portal, go to the API Menu, then click on the \"Tokens\" submenu.
To create a token click on \"Add Token\" in the right upper corner.
A pop-up will appear. Select which function(s) to associate with the token.

When making requests you should use \"Basic auth\". To create the authentication string you will need your Commio username and your Commio API token. Combine these with a colon (:) and Base64 encode that string to produce your authentication string.
For example, if your username is testuser and your Commio token is 3f631df0a3631df0a3, you would Base64 encode:

testuser:3f631df0a3631df0a3

Which would result in an authentication string of:

dGVzdHVzZXI6M2Y2MzFkZjBhMzYzMWRmMGEz

And so, your authentication header would be:

Authorization: Basic dGVzdHVzZXI6M2Y2MzFkZjBhMzYzMWRmMGEz

Make sure to copy the token that you will use to authenticate the API calls. Please keep the token safe. If you suspect your token has been compromised, you can always delete the token and create a new one in the customer portal.

Pagination:

Most GET resources support pagination and max rows per page with the following arguments:
page=1&rows=25

\n","event":[{"listen":"prerequest","script":{"id":"a48a56e9-80a5-4f84-bcd0-df921a5e6172","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d6e00e7f-1e2d-4e15-9521-b96ef60727d3","type":"text/javascript","exec":[""]}}],"_postman_id":"a489f519-eb19-4c6f-b66d-d8f791914353","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Outbound","item":[{"name":"Profiles","item":[{"name":"/profiles","id":"6027068c-6678-44d5-833c-5df2ff5fc388","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/profiles?rowsPerPage=25¤tPage=1&sort=desc&search=name:test","description":"

Get full details on all routing profiles belonging to the authenticated user's account.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","profiles"],"host":["https://api.thinq.com"],"query":[{"description":{"content":"

(Required)

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

(Required)

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

asc OR desc

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

name OR id

\n","type":"text/plain"},"key":"search","value":"name:test"}],"variable":[]}},"response":[{"id":"01d4728a-bfc1-42d7-aad7-cd3a1c1e9b28","name":"Default Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.thinq.com/outbound/profiles?rowsPerPage=25¤tPage=1&sort=desc&search=name:test","protocol":"https","host":["api","thinq","com"],"path":["outbound","profiles"],"query":[{"key":"rowsPerPage","value":"25"},{"key":"currentPage","value":"1"},{"key":"sort","value":"desc","description":"asc OR desc"},{"key":"search","value":"name:test","description":"name OR id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 15968,\n \"name\": \"test\",\n \"routingOption\": 2,\n \"intlRoutingOption\": null,\n \"maxRate\": 0.9999,\n \"intlMaxRate\": null,\n \"maxDepth\": 10,\n \"intlMaxDepth\": null,\n \"carrierList\": \"10,20,30,40,50,60,70,80,90,100\",\n \"intlCarrierList\": null,\n \"pddTimer\": 10,\n \"intlPddTimer\": null\n },\n ],\n \"totalRows\": 59,\n \"rowsPerPage\": 10,\n \"hasPrevPage\": false,\n \"hasNextPage\": true,\n \"currentPage\": 1,\n \"totalPages\": 6\n}"}],"_postman_id":"6027068c-6678-44d5-833c-5df2ff5fc388"},{"name":"/profiles/basic","id":"5b7baf9c-eddf-4c71-8528-35779a7a166a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/profiles/basic?rowsPerPage=10¤tPage=1&sort=desc","description":"

Get limited details on all routing profiles belong to the authenticated user's account

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","profiles","basic"],"host":["https://api.thinq.com"],"query":[{"description":{"content":"

(Required)

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

(Required)

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

asc OR desc

\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"4f030ba8-55da-4211-aed9-598bee269d21","name":"Default Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.thinq.com/outbound/profiles/basic?rowsPerPage=25¤tPage=1&sort=desc","protocol":"https","host":["api","thinq","com"],"path":["outbound","profiles","basic"],"query":[{"key":"rowsPerPage","value":"25"},{"key":"currentPage","value":"1"},{"key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 10000,\n \"name\": \"Example A\"\n },\n {\n \"id\": 11000,\n \"name\": \"Example B\"\n },\n {\n \"id\": 12000,\n \"name\": \"Example C\"\n },\n {\n \"id\": 13000,\n \"name\": \"Example D\"\n },\n {\n \"id\": 14000,\n \"name\": \"Example E\"\n }\n ],\n \"totalRows\": 59,\n \"rowsPerPage\": 5,\n \"hasPrevPage\": false,\n \"hasNextPage\": true,\n \"currentPage\": 1,\n \"totalPages\": 6\n}"}],"_postman_id":"5b7baf9c-eddf-4c71-8528-35779a7a166a"},{"name":"/profiles","id":"05cc42c9-1e0b-44a1-820e-dcaf94ede57c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Profile\",\n \"routingOption\": 2,\n \"pddTimer\": 10,\n \"maxRate\": 0.9999,\n \"maxDepth\": 10,\n \"carrierList\": \"78,91\",\n \"intlRoutingOption\": 2,\n \"intlPddTimer\": 10,\n \"intlMaxRate\": 1,\n \"intlMaxDepth\": 10,\n \"intlCarrierList\": \"78,91\"\n}"},"url":"https://api.thinq.com/outbound/profiles","description":"

Create a new routing profile for the authenticated user's account.

The \"routingOption\" parameter must be set to 2 for LCR (Least Cost Routing). Prime profiles cannot be created.

The maximum for the \"maxRate\" parameter is 0.9999.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","profiles"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"1fe786d3-af34-474b-9be0-bcd3e7049b5e","name":"Default Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Profile\",\n \"routingOption\": 2,\n \"pddTimer\": 10,\n \"maxRate\": 0.9999,\n \"maxDepth\": 10,\n \"carrierList\": \"78,91\",\n \"intlRoutingOption\": 2,\n \"intlPddTimer\": 10,\n \"intlMaxRate\": 1,\n \"intlMaxDepth\": 10,\n \"intlCarrierList\": \"78,91\"\n}"},"url":"https://api.thinq.com/outbound/profiles"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Profile saved successfully\",\n \"data\": {\n \"id\": 12345\n }\n}"}],"_postman_id":"05cc42c9-1e0b-44a1-820e-dcaf94ede57c"},{"name":"/profiles/:id","id":"e87e33a3-4f4e-4572-8aa8-e10614e5bb29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Profile\",\n \"routingOption\": 2,\n \"pddTimer\": 10,\n \"maxRate\": 0.9999,\n \"maxDepth\": 10,\n \"carrierList\": \"78,91\",\n \"intlRoutingOption\": 2,\n \"intlPddTimer\": 10,\n \"intlMaxRate\": 1,\n \"intlMaxDepth\": 10,\n \"intlCarrierList\": \"78,91\"\n}"},"url":"https://api.thinq.com/outbound/profiles/:id","description":"

Update a routing profile by id.

The \"routingOption\" parameter must be set to 2 for LCR (Least Cost Routing). Prime profiles cannot be edited.

The maximum for the \"maxRate\" parameter is 0.9999.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","profiles",":id"],"host":["https://api.thinq.com"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"62","key":"id"}]}},"response":[{"id":"d0db8c70-4e7c-4121-aba7-c00507ad2341","name":"Default Response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Profile PUT\",\n \"routingOption\": 2,\n \"pddTimer\": 10,\n \"maxRate\": 0.9999,\n \"maxDepth\": 10,\n \"carrierList\": \"78,91\",\n \"intlRoutingOption\": 2,\n \"intlPddTimer\": 10,\n \"intlMaxRate\": 1,\n \"intlMaxDepth\": 10,\n \"intlCarrierList\": \"78,91\"\n}"},"url":{"raw":"https://api.thinq.com/outbound/profiles/:id","protocol":"https","host":["api","thinq","com"],"path":["outbound","profiles",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Profile updated successfully\",\n \"data\": null\n}"}],"_postman_id":"e87e33a3-4f4e-4572-8aa8-e10614e5bb29"},{"name":"/profiles/:id","id":"0ceffcfd-112c-4746-8834-ef8316d55b9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.thinq.com/outbound/profiles/:id","description":"

Delete a routing profile by id

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","profiles",":id"],"host":["https://api.thinq.com"],"query":[],"variable":[{"id":"a01c49dd-96b9-4fc1-b32a-07bca56eb7fd","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"string","value":"42","key":"id"}]}},"response":[{"id":"7ed56ac8-0e5c-4fa1-9c99-22dd4575a9cc","name":"Default Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.thinq.com/outbound/profiles/:id","protocol":"https","host":["api","thinq","com"],"path":["outbound","profiles",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Profile deleted successfully\",\n \"data\": null\n}"}],"_postman_id":"0ceffcfd-112c-4746-8834-ef8316d55b9d"}],"id":"019e9d15-f1f7-4d5f-9789-5a414f885e1d","_postman_id":"019e9d15-f1f7-4d5f-9789-5a414f885e1d","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"Carriers","item":[{"name":"/carriers","id":"d5e39baa-3efc-45e0-a2da-a910dd006748","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/carriers","description":"

Get all carriers available for outbound

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","carriers"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"71b7ea2e-fcf5-49b3-9953-01078c562609","name":"Untitled Example","originalRequest":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/carriers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 78,\n \"description\": \"Carrier Name\",\n \"carrier_group\": \"Group\",\n \"icon_path\": \"/static/new_images/logos/382.png\"\n },\n {\n \"id\": 78,\n \"description\": \"Carrier Name\",\n \"carrier_group\": \"Group\",\n \"icon_path\": \"/static/new_images/logos/382.png\"\n }\n]"}],"_postman_id":"d5e39baa-3efc-45e0-a2da-a910dd006748"},{"name":"/carriers/ids","id":"39275b9a-29e2-479a-a372-ecc26a031dcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/carriers/ids?carrierList=1&intlCarrierList=1","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","carriers","ids"],"host":["https://api.thinq.com"],"query":[{"key":"carrierList","value":"1"},{"key":"intlCarrierList","value":"1"}],"variable":[]}},"response":[{"id":"4475dc8f-c0b2-4ecf-81ad-24cc0f2e37e6","name":"Default Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.thinq.com/outbound/carriers/ids?carrierList=1&intlCarrierList=1","host":["https://api.thinq.com"],"path":["outbound","carriers","ids"],"query":[{"key":"carrierList","value":"1"},{"key":"intlCarrierList","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"39275b9a-29e2-479a-a372-ecc26a031dcb"}],"id":"d31fbd7a-c2ed-4bd6-b250-46be34ed82d5","_postman_id":"d31fbd7a-c2ed-4bd6-b250-46be34ed82d5","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"Route Blocks","item":[{"name":"{id}","item":[{"name":"/routeblocks/:id","id":"9149f067-d275-49fc-bea5-320c1588a6a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"profileId\": 1,\n \"carrierIds\": [\n 33,\n 45\n ],\n \"type\": \"npa\",\n \"expiration\": \"2020-10-20\",\n \"states\": [\n \"NC\",\n \"SC\"\n ],\n \"singleState\": \"NC\",\n \"lata\": \"426\",\n \"ocn\": \"997C\",\n \"npa\": \"919\",\n \"nxx\": \"555\",\n \"rateCenters\": [\n \"SPRINGFIELD\"\n ],\n \"countryId\": 1,\n \"note\": \"My note\"\n}"},"url":"https://api.thinq.com/outbound/routeblocks/:id","description":"

Create a new route block. Type property must be one of the following: \"npa\", \"nxx\", \"npanxx\", \"lata\", \"lataocn\", \"state\", \"ratecenter\". Required fields change based on chosen type:

    TYPE: REQUIRED FIELDS\n\n    npa: [\"npa\"]\n\n    npanxx: [\"npa\", \"nxx\"]\n\n    lata: [\"lata\"]\n\n    lataocn: [\"lata\", \"ocn\"]\n\n    state: [\"states\"] OR [\"singleState\"]\n\n    ratecenter: [\"ratecenter\"] \n

(Required) ID of the route block to update

\n","type":"text/plain"},"type":"string","value":"1","key":"id"}]}},"response":[{"id":"fd7310a3-1e93-4f9c-bb5f-904fc7438e9f","name":"Untitled Example","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"profileId\": 1,\n \"carrierIds\": [\n 33,\n 45\n ],\n \"type\": \"npa\",\n \"expiration\": \"2020-10-20\",\n \"states\": [\n \"NC\",\n \"SC\"\n ],\n \"singleState\": \"NC\",\n \"lata\": \"426\",\n \"ocn\": \"997C\",\n \"npa\": \"919\",\n \"nxx\": \"555\",\n \"rateCenters\": [\n \"officia ea adipisicing minim\",\n \"esse ullamco et\"\n ],\n \"countryId\": 1,\n \"note\": \"My note\"\n}"},"url":{"raw":"https://api.thinq.com/outbound/routeblocks/:id","host":["https://api.thinq.com"],"path":["outbound","routeblocks",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 100\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"9149f067-d275-49fc-bea5-320c1588a6a7"},{"name":"/routeblocks/:id","id":"c6123aab-e14e-4961-a366-42fa1b75a967","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.thinq.com/outbound/routeblocks/:id","description":"

Delete an outbound route block

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","routeblocks",":id"],"host":["https://api.thinq.com"],"query":[],"variable":[{"id":"4354f278-c5f9-4d22-bef2-afef5fbdf470","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"string","value":"1","key":"id"}]}},"response":[{"id":"5d008315-2189-4d42-90ce-7acd02863cb9","name":"Untitled Example","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.thinq.com/outbound/routeblocks/:id","host":["https://api.thinq.com"],"path":["outbound","routeblocks",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"c6123aab-e14e-4961-a366-42fa1b75a967"},{"name":"/routeblocks/:id","id":"a6297dc6-8dea-4258-bde9-eb0cb14e65f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/routeblocks/:id","description":"

Get outbound route block details by id. Only returns non-null fields (ex. an NPA block won't return a rateCenters field)

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","routeblocks",":id"],"host":["https://api.thinq.com"],"query":[],"variable":[{"id":"4fa141ac-72f2-46cd-b82c-a0ed7d471c68","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"string","value":"1","key":"id"}]}},"response":[{"id":"c38ac78e-f077-405c-a0c7-66411922e798","name":"Untitled Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.thinq.com/outbound/routeblocks/:id","host":["https://api.thinq.com"],"path":["outbound","routeblocks",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": 3201,\n \"carrierIds\": [\n -43168256,\n 23592955\n ],\n \"created\": \"2020-04-07T23:29:35.000Z\",\n \"expiration\": \"2020-04-10T00:00:00.000Z\",\n \"id\": 1,\n \"lata\": \"910\",\n \"name\": \"My Route Block\",\n \"note\": \"Some notes\",\n \"npa\": \"919\",\n \"npanxxy\": \"9195551\",\n \"nxx\": \"555\",\n \"ocn\": \"999\",\n \"profileId\": 100,\n \"routeBlockIds\": [\n 1100,\n 1101\n ],\n \"rateCenters\": [\n \"SPRINGFIELD\"\n ],\n \"routeBlockType\": \"lataocn\",\n \"states\": [\n \"NC\"\n ],\n \"username\": \"jsmith\"\n}"}],"_postman_id":"a6297dc6-8dea-4258-bde9-eb0cb14e65f9"}],"id":"495d904e-1754-414f-a0c4-d71b814241cf","_postman_id":"495d904e-1754-414f-a0c4-d71b814241cf","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"international","item":[{"name":"/routeblocks/international","id":"04c9324e-3c79-4206-9f9f-110a4bb9ff25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/routeblocks/international?rowsPerPage=25¤tPage=1&sort=eu","description":"

Get all international route blocks associated with the logged in user's account

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","routeblocks","international"],"host":["https://api.thinq.com"],"query":[{"description":{"content":"

(Required)

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

(Required)

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

column:asc OR column:desc (ex. id:desc)

\n","type":"text/plain"},"key":"sort","value":"eu"}],"variable":[]}},"response":[{"id":"ac3d7ca0-5310-47f0-8e04-95d99cd86367","name":"Untitled Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.thinq.com/outbound/routeblocks/international?rowsPerPage=25¤tPage=1&sort=eu","host":["https://api.thinq.com"],"path":["outbound","routeblocks","international"],"query":[{"key":"rowsPerPage","value":"25"},{"key":"currentPage","value":"1"},{"key":"sort","value":"eu"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"profileId\": 1,\n \"userId\": 0,\n \"created\": \"2020-09-02T23:57:38.000Z\",\n \"expiration\": \"2020-09-18T04:00:00.000Z\",\n \"countryId\": 29,\n \"note\": \"My note\",\n \"name\": \"Route Block Name\",\n \"username\": \"jsmith\",\n \"countryName\": \"Algeria\",\n \"description\": \"Test description\",\n \"carriers\": \"Airtel\",\n \"routingProfile\": \"Routing Profile\"\n },\n {\n \"id\": 1,\n \"profileId\": 1,\n \"userId\": 0,\n \"created\": \"2020-09-02T23:57:38.000Z\",\n \"expiration\": \"2020-09-18T04:00:00.000Z\",\n \"countryId\": 29,\n \"note\": \"My note\",\n \"name\": \"Route Block Name\",\n \"username\": \"jsmith\",\n \"countryName\": \"Algeria\",\n \"description\": \"Test description\",\n \"carriers\": \"Airtel\",\n \"routingProfile\": \"Routing Profile\"\n }\n ],\n \"totalRows\": 1,\n \"rowsPerPage\": 25,\n \"hasPrevPage\": false,\n \"hasNextPage\": true,\n \"currentPage\": 1,\n \"totalPages\": 1\n}"}],"_postman_id":"04c9324e-3c79-4206-9f9f-110a4bb9ff25"},{"name":"/routeblocks/international","id":"88c7737b-d745-4f8a-9452-36ba05cfe2ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"profileId\": 1,\n \"carrierIds\": [\n 36277242,\n -33405864\n ],\n \"countryIds\": [\n 29\n ],\n \"expiration\": \"2020-09-18T04:00:00.000Z\",\n \"note\": \"My note\"\n}"},"url":"https://api.thinq.com/outbound/routeblocks/international","description":"

Create new international route blocks for the authenticated user's account

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","routeblocks","international"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"ff3de46a-15b8-480f-8bec-08c54a51a2a0","name":"Untitled Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"profileId\": 1,\n \"carrierIds\": [\n 22542295,\n -87532343\n ],\n \"countryIds\": [\n 38370076,\n -89747637\n ],\n \"expiration\": \"2020-09-18T04:00:00.000Z\",\n \"note\": \"My note\"\n}"},"url":"https://api.thinq.com/outbound/routeblocks/international"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"88c7737b-d745-4f8a-9452-36ba05cfe2ac"},{"name":"/routeblocks/international/:id","id":"9e45b531-6d03-4f5f-a9a6-e96e482bfb00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.thinq.com/outbound/routeblocks/international/:id","description":"

Delete an international route block by id

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","routeblocks","international",":id"],"host":["https://api.thinq.com"],"query":[],"variable":[{"id":"5201c1a5-674e-4358-b3b2-d3f46869aa1f","description":{"content":"

(Required) ID of the international route block to delete

\n","type":"text/plain"},"type":"string","value":"55","key":"id"}]}},"response":[{"id":"2fc4303c-8c5f-42ef-83de-8110800600f6","name":"Untitled Example","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.thinq.com/outbound/routeblocks/international/:id","host":["https://api.thinq.com"],"path":["outbound","routeblocks","international",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"9e45b531-6d03-4f5f-a9a6-e96e482bfb00"}],"id":"9b33636c-e9fe-415e-8181-44808f2e0700","_postman_id":"9b33636c-e9fe-415e-8181-44808f2e0700","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"/routeblocks","id":"b5986f89-8c44-4c31-9af3-45f3d172aaac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/routeblocks?rowsPerPage=25¤tPage=1&sort=eu","description":"

Get all outbound route blocks for the logged in user's account

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","routeblocks"],"host":["https://api.thinq.com"],"query":[{"description":{"content":"

(Required)

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

(Required)

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

column:asc OR column:desc (ex. id:desc)

\n","type":"text/plain"},"key":"sort","value":"eu"}],"variable":[]}},"response":[{"id":"a54aa228-875b-4bac-a44d-0120fd7fe77c","name":"Untitled Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.thinq.com/outbound/routeblocks?rowsPerPage=25¤tPage=1&sort=eu","host":["https://api.thinq.com"],"path":["outbound","routeblocks"],"query":[{"key":"rowsPerPage","value":"25"},{"key":"currentPage","value":"1"},{"key":"sort","value":"eu"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"accountId\": 3201,\n \"carrierIds\": [\n -40494486,\n -42169754\n ],\n \"created\": \"2020-04-07T23:29:35.000Z\",\n \"expiration\": \"2020-04-10T00:00:00.000Z\",\n \"id\": 1,\n \"lata\": \"910\",\n \"name\": \"My Route Block\",\n \"note\": \"Some notes\",\n \"npa\": \"919\",\n \"npanxxy\": \"9195551\",\n \"nxx\": \"555\",\n \"ocn\": \"999\",\n \"profileId\": 100,\n \"routeBlockIds\": [\n 1100,\n 1101\n ],\n \"rateCenters\": [\n \"SPRINGFIELD\"\n ],\n \"routeBlockType\": \"lataocn\",\n \"states\": [\n \"NC\"\n ],\n \"username\": \"jsmith\"\n },\n {\n \"accountId\": 3201,\n \"carrierIds\": [\n -36300182,\n -37928580\n ],\n \"created\": \"2020-04-07T23:29:35.000Z\",\n \"expiration\": \"2020-04-10T00:00:00.000Z\",\n \"id\": 1,\n \"lata\": \"910\",\n \"name\": \"My Route Block\",\n \"note\": \"Some notes\",\n \"npa\": \"919\",\n \"npanxxy\": \"9195551\",\n \"nxx\": \"555\",\n \"ocn\": \"999\",\n \"profileId\": 100,\n \"routeBlockIds\": [\n 1100,\n 1101\n ],\n \"rateCenters\": [\n \"SPRINGFIELD\"\n ],\n \"routeBlockType\": \"lataocn\",\n \"states\": [\n \"NC\"\n ],\n \"username\": \"jsmith\"\n }\n ],\n \"totalRows\": 1,\n \"rowsPerPage\": 25,\n \"hasPrevPage\": false,\n \"hasNextPage\": true,\n \"currentPage\": 1,\n \"totalPages\": 1\n}"}],"_postman_id":"b5986f89-8c44-4c31-9af3-45f3d172aaac"},{"name":"/routeblocks","id":"c8c91f0a-afec-4062-b7f0-592b0b7d034c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"profileId\": 1,\n \"carrierIds\": [\n 33,\n 45\n ],\n \"type\": \"npa\",\n \"expiration\": \"2020-10-20\",\n \"states\": [\n \"NC\",\n \"SC\"\n ],\n \"singleState\": \"NC\",\n \"lata\": \"426\",\n \"ocn\": \"997C\",\n \"npa\": \"919\",\n \"nxx\": \"555\",\n \"rateCenters\": [\n \"SPRINGFIELD\"\n ],\n \"countryId\": 1,\n \"note\": \"My note\"\n}"},"url":"https://api.thinq.com/outbound/routeblocks","description":"

Create a new route block. Type property must be one of the following: \"npa\", \"nxx\", \"npanxx\", \"lata\", \"lataocn\", \"state\", \"ratecenter\". Required fields change based on chosen type:

    TYPE: REQUIRED FIELDS\n\n    npa: [\"npa\"]\n\n    npanxx: [\"npa\", \"nxx\"]\n\n    lata: [\"lata\"]\n\n    lataocn: [\"lata\", \"ocn\"]\n\n    state: [\"states\"] OR [\"singleState\"]\n\n    ratecenter: [\"ratecenter\"] \n

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","routeblocks"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"3f24d420-fcbd-42f9-a103-b62d01ac7221","name":"Untitled Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"profileId\": 1,\n \"carrierIds\": [\n 33,\n 45\n ],\n \"type\": \"npa\",\n \"expiration\": \"2020-10-20\",\n \"states\": [\n \"NC\",\n \"SC\"\n ],\n \"singleState\": \"NC\",\n \"lata\": \"426\",\n \"ocn\": \"997C\",\n \"npa\": \"919\",\n \"nxx\": \"555\",\n \"rateCenters\": [\n \"officia ea adipisicing minim\",\n \"esse ullamco et\"\n ],\n \"countryId\": 1,\n \"note\": \"My note\"\n}"},"url":"https://api.thinq.com/outbound/routeblocks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 100\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"c8c91f0a-afec-4062-b7f0-592b0b7d034c"}],"id":"b71d1ad6-ced3-4217-86d2-048ff3bb6d3c","_postman_id":"b71d1ad6-ced3-4217-86d2-048ff3bb6d3c","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"Trunks","item":[{"name":"{id}","item":[{"name":"/trunks/:id","id":"a72f2457-7512-40bd-80bb-3b317e1728c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/trunks/:id","description":"

Get a trunk by id

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","trunks",":id"],"host":["https://api.thinq.com"],"query":[],"variable":[{"id":"90b08fd8-b0de-46e4-b36e-316d0f93882c","description":{"content":"

(Required) ID of the trunk to retrieve

\n","type":"text/plain"},"type":"string","value":"1","key":"id"}]}},"response":[{"id":"28786736-2fa2-4bf8-8cbf-fae59c777c5a","name":"Successful response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.thinq.com/outbound/trunks/:id","host":["https://api.thinq.com"],"path":["outbound","trunks",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"trunkTypeId\": 1,\n \"accountId\": 3102,\n \"profileId\": 1,\n \"profileName\": \"Profile\",\n \"name\": \"My Trunk\",\n \"enabled\": 1,\n \"address\": \"192.23.24.238\",\n \"prefix\": \"1234\",\n \"comment\": \"Some comment\",\n \"updated\": \"esse ullamco exercitation consectetur quis\",\n \"channelLimit\": 35,\n \"channelLimitBox\": 200,\n \"trafficClass\": \"laborum qui Lorem\",\n \"token\": \"ex\"\n },\n {\n \"id\": 1,\n \"trunkTypeId\": 1,\n \"accountId\": 3102,\n \"profileId\": 1,\n \"profileName\": \"Profile\",\n \"name\": \"My Trunk\",\n \"enabled\": 1,\n \"address\": \"192.23.24.238\",\n \"prefix\": \"1234\",\n \"comment\": \"Some comment\",\n \"updated\": \"commodo velit cillum dolor\",\n \"channelLimit\": 35,\n \"channelLimitBox\": 200,\n \"trafficClass\": \"veniam\",\n \"token\": \"laboris Lorem proident in\"\n }\n]"}],"_postman_id":"a72f2457-7512-40bd-80bb-3b317e1728c1"},{"name":"/trunks/:id","id":"0ba9631d-2849-4e78-9a96-0ecd79e32cc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"trunkTypeId\": 1,\n \"name\": \"Test Trunk\",\n \"profileId\": 123,\n \"channelLimit\": 50,\n \"prefix\": \"1234\",\n \"address\": \"192.24.23.125\",\n \"addressEnd\": 255\n}"},"url":"https://api.thinq.com/outbound/trunks/:id","description":"

Update a trunk by id

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","trunks",":id"],"host":["https://api.thinq.com"],"query":[],"variable":[{"id":"22e68cac-a43d-4388-a572-732cdb94d072","description":{"content":"

(Required) ID of the trunk to edit

\n","type":"text/plain"},"type":"string","value":"1","key":"id"}]}},"response":[{"id":"6d78bf66-3218-4aa9-8d26-535423471cb2","name":"Successful response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"trunkTypeId\": 1,\n \"name\": \"Test Trunk\",\n \"profileId\": 123,\n \"channelLimit\": 50,\n \"prefix\": \"1234\",\n \"address\": \"192.24.23.125\",\n \"addressEnd\": 255\n}"},"url":{"raw":"https://api.thinq.com/outbound/trunks/:id","host":["https://api.thinq.com"],"path":["outbound","trunks",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"0ba9631d-2849-4e78-9a96-0ecd79e32cc3"},{"name":"/trunks/:id","id":"ec96f8c3-3f29-46e1-8a24-0e09c9618352","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.thinq.com/outbound/trunks/:id","description":"

Delete a trunk

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","trunks",":id"],"host":["https://api.thinq.com"],"query":[],"variable":[{"id":"8b2dd147-5ce4-440f-8335-63ef7f282e34","description":{"content":"

(Required) ID of the trunk to delete

\n","type":"text/plain"},"type":"string","value":"1","key":"id"}]}},"response":[{"id":"496b9c3f-ee91-4e95-8c55-5a6b8d2f327a","name":"Untitled Example","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.thinq.com/outbound/trunks/:id","host":["https://api.thinq.com"],"path":["outbound","trunks",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"ec96f8c3-3f29-46e1-8a24-0e09c9618352"}],"id":"bdbbd1ec-9b30-42e1-9442-c5b76c41fd66","_postman_id":"bdbbd1ec-9b30-42e1-9442-c5b76c41fd66","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"/trunks","id":"64430a4b-5c25-4de7-8569-8c954ea97935","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/trunks?rowsPerPage=25¤tPage=1&sort=eu","description":"

Get all trunks belonging to the logged in user's account

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","trunks"],"host":["https://api.thinq.com"],"query":[{"description":{"content":"

(Required)

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

(Required)

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

column:asc OR column:desc (ex. id:desc)

\n","type":"text/plain"},"key":"sort","value":"eu"}],"variable":[]}},"response":[{"id":"aa75a99c-dcac-43c1-8aaf-a4244172902b","name":"Successful response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.thinq.com/outbound/trunks?rowsPerPage=25¤tPage=1&sort=eu","host":["https://api.thinq.com"],"path":["outbound","trunks"],"query":[{"key":"rowsPerPage","value":"25"},{"key":"currentPage","value":"1"},{"key":"sort","value":"eu"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"trunkTypeId\": 1,\n \"accountId\": 3102,\n \"profileId\": 1,\n \"profileName\": \"Profile\",\n \"name\": \"My Trunk\",\n \"enabled\": 1,\n \"address\": \"192.23.24.238\",\n \"prefix\": \"1234\",\n \"comment\": \"Some comment\",\n \"updated\": \"et laboris exercitation\",\n \"channelLimit\": 35,\n \"channelLimitBox\": 200,\n \"trafficClass\": \"\",\n \"accountChannelLimit\": 50,\n \"token\": \"irure Duis pariatur\"\n },\n {\n \"id\": 1,\n \"trunkTypeId\": 1,\n \"accountId\": 3102,\n \"profileId\": 1,\n \"profileName\": \"Profile\",\n \"name\": \"My Trunk\",\n \"enabled\": 1,\n \"address\": \"192.23.24.238\",\n \"prefix\": \"1234\",\n \"comment\": \"Some comment\",\n \"updated\": \"sed officia occaecat et magna\",\n \"channelLimit\": 35,\n \"channelLimitBox\": 200,\n \"trafficClass\": \"anim do\",\n \"accountChannelLimit\": 50,\n \"token\": \"eiusmod dolore sed est\"\n }\n ],\n \"totalRows\": 1,\n \"rowsPerPage\": 25,\n \"hasPrevPage\": false,\n \"hasNextPage\": true,\n \"currentPage\": 1,\n \"totalPages\": 1\n}"}],"_postman_id":"64430a4b-5c25-4de7-8569-8c954ea97935"},{"name":"/trunks","id":"2d9d6c64-60ec-4c25-903d-83ad2eede4af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"trunkTypeId\": 1,\n \"name\": \"Test Trunk\",\n \"profileId\": 123,\n \"channelLimit\": 55,\n \"prefix\": \"1234\",\n \"address\": \"192.24.23.125\",\n \"addressEnd\": 255\n}"},"url":"https://api.thinq.com/outbound/trunks","description":"

Create a new trunk

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","trunks"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"ae89d0ce-15d1-47e8-9af0-10bc19a0f014","name":"Successful response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"trunkTypeId\": 1,\n \"name\": \"Test Trunk\",\n \"profileId\": 123,\n \"channelLimit\": 55,\n \"prefix\": \"1234\",\n \"address\": \"192.24.23.125\",\n \"addressEnd\": 255\n}"},"url":"https://api.thinq.com/outbound/trunks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"2d9d6c64-60ec-4c25-903d-83ad2eede4af"},{"name":"/trunks/profile/:id","id":"2d08709d-7ec7-4587-89dd-dfb1dfe53c72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/trunks/profile/:id","description":"

Get all trunks associated to a specific profile

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","trunks","profile",":id"],"host":["https://api.thinq.com"],"query":[],"variable":[{"id":"1e623114-9db8-46c0-af70-79bb32c8cbe6","description":{"content":"

(Required) ID of profile to retrieve associated trunks for

\n","type":"text/plain"},"type":"string","value":"1","key":"id"}]}},"response":[{"id":"b219c9a9-cdaf-4eda-9bc2-1971c5154dc9","name":"Untitled Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.thinq.com/outbound/trunks/profile/:id","host":["https://api.thinq.com"],"path":["outbound","trunks","profile",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"trunkTypeId\": 1,\n \"name\": \"Trunk Name\",\n \"address\": \"10.10.10.10\",\n \"prefix\": \"1234\",\n \"channelLimit\": 200\n },\n {\n \"id\": 1,\n \"trunkTypeId\": 1,\n \"name\": \"Trunk Name\",\n \"address\": \"10.10.10.10\",\n \"prefix\": \"1234\",\n \"channelLimit\": 200\n }\n]"}],"_postman_id":"2d08709d-7ec7-4587-89dd-dfb1dfe53c72"},{"name":"/trunks/associate","id":"d6fd3beb-b35a-4681-a9c6-4ec170a0018b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"profileId\": 34,\n \"trunkIds\": [\n 121,\n 293\n ]\n}"},"url":"https://api.thinq.com/outbound/trunks/associate","description":"

Assign an array of trunks to an outbound routing profile

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","trunks","associate"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"9768f03c-649b-460f-89de-687915db2ae1","name":"Untitled Example","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"profileId\": 34,\n \"trunkIds\": [\n 121,\n 293\n ]\n}"},"url":"https://api.thinq.com/outbound/trunks/associate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"profileId\": 34,\n \"trunkIds\": [\n 121,\n 293\n ]\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"d6fd3beb-b35a-4681-a9c6-4ec170a0018b"}],"id":"3ca60fb1-dc69-4b80-a74d-279fafae3fe5","_postman_id":"3ca60fb1-dc69-4b80-a74d-279fafae3fe5","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"Rate Centers","item":[{"name":"/lerg/ratecenters/:state","id":"c26ae525-dfda-4efb-8133-66f62355568a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/lerg/ratecenters/:state","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","lerg","ratecenters",":state"],"host":["https://api.thinq.com"],"query":[],"variable":[{"id":"281c03bd-f592-40e3-ba87-cb488b2d6e49","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"string","value":"NC","key":"state"}]}},"response":[{"id":"f60eeabe-8bf5-4148-a1b3-6547abd0f2dc","name":"Default Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.thinq.com/outbound/lerg/ratecenters/:state","host":["https://api.thinq.com"],"path":["outbound","lerg","ratecenters",":state"],"variable":[{"key":"state"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c26ae525-dfda-4efb-8133-66f62355568a"}],"id":"13f46dbf-a7f2-4535-be39-d31a36b4ed06","_postman_id":"13f46dbf-a7f2-4535-be39-d31a36b4ed06","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"Countries","item":[{"name":"/countries","id":"a1048fa1-09fb-45f5-8b6b-0eb780f7c253","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/countries","description":"

Get all countries supported by international route blocks

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","countries"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"eaccc154-7dc4-485b-a77c-c0f8637f0418","name":"Successful response","originalRequest":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/countries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n\t{\n\t\t\"id\": 207,\n\t\t\"name\": \"Afghanistan\",\n\t\t\"code\": 93\n\t},\n\t{\n\t\t\"id\": 95,\n\t\t\"name\": \"Albania\",\n\t\t\"code\": 355\n\t},\n\t{\n\t\t\"id\": 29,\n\t\t\"name\": \"Algeria\",\n\t\t\"code\": 213\n\t},\n\t{\n\t\t\"id\": 107,\n\t\t\"name\": \"Andorra\",\n\t\t\"code\": 376\n\t},\n\t{\n\t\t\"id\": 56,\n\t\t\"name\": \"Angola\",\n\t\t\"code\": 244\n\t}\n]"}],"_postman_id":"a1048fa1-09fb-45f5-8b6b-0eb780f7c253"},{"name":"/countries/:id","id":"0302712c-11b3-402b-8afc-832508d4a699","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/countries/:id","description":"

Get a specific country name by id

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","countries",":id"],"host":["https://api.thinq.com"],"query":[],"variable":[{"id":"20ccff6b-a84d-4bd3-b75b-7e83c34b46d2","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"string","value":"82","key":"id"}]}},"response":[{"id":"7170c2dd-4517-441f-985a-83ba4ae8711e","name":"Successful response","originalRequest":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/countries/82"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n\t{\n\t\t\"name\": \"Aruba\"\n\t}\n]"}],"_postman_id":"0302712c-11b3-402b-8afc-832508d4a699"}],"id":"716f4fe9-0754-4eb0-bec5-00bdf2e4216e","_postman_id":"716f4fe9-0754-4eb0-bec5-00bdf2e4216e","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"Rate Decks","item":[{"name":"/ratedecks","id":"3d608f5a-3184-4511-871d-493d4c837c9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/ratedecks","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","ratedecks"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"8f1322d3-5993-4739-bd95-ed3a036c2231","name":"Default Response","originalRequest":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/ratedecks"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3d608f5a-3184-4511-871d-493d4c837c9d"},{"name":"/ratedecks/download/:fileName","id":"eb58444f-a00e-4414-a1f2-4d03ab6724ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/ratedecks/download/:fileName","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","ratedecks","download",":fileName"],"host":["https://api.thinq.com"],"query":[],"variable":[{"id":"4d6524c1-2e21-45ca-ab43-ee885afac2ab","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"string","value":"eiusmod id Duis","key":"fileName"}]}},"response":[{"id":"79ccd0d7-5f16-4b58-b67d-8ba205cb995a","name":"Default Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.thinq.com/outbound/ratedecks/download/:fileName","host":["https://api.thinq.com"],"path":["outbound","ratedecks","download",":fileName"],"variable":[{"key":"fileName"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"eb58444f-a00e-4414-a1f2-4d03ab6724ff"}],"id":"94053b53-c65c-4886-9563-f1d8b07f2fc2","_postman_id":"94053b53-c65c-4886-9563-f1d8b07f2fc2","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"Balance","item":[{"name":"/balance","id":"8df5d75c-2380-4756-8eec-bb58ef2e0ce8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/balance","description":"

Get the current outbound balance on the logged in user's account

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["outbound","balance"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"a512bb7d-2ace-4efc-b8d2-32fe38f9c177","name":"Untitled Example","originalRequest":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"balance\": 2340.27\n}"}],"_postman_id":"8df5d75c-2380-4756-8eec-bb58ef2e0ce8"}],"id":"9ca6b686-5429-4624-87ca-1c810b347a1d","_postman_id":"9ca6b686-5429-4624-87ca-1c810b347a1d","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"CDRs","item":[{"name":"/cdrs","id":"6d91f805-f4ad-4f2f-94d9-95c9fd33d881","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/outbound/cdrs?rowsPerPage=25¤tPage=1&sort=desc&dateStart=2020-09-17&dateEnd=2020-09-18&failed=true&didTo=9192687435&didFrom=3056789120&csv=","description":"

Get all CDRs in a time range. dateStart and dateEnd can be in the format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ.

        Note: retail, billable, and totalRetail fields only return for completed calls. sipCode and sipReason only return for failed calls.\n

(Required)

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

(Required)

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

column:asc OR column:desc (ex. id:desc)

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

(Required)

\n","type":"text/plain"},"key":"dateStart","value":"2020-09-17"},{"description":{"content":"

(Required)

\n","type":"text/plain"},"key":"dateEnd","value":"2020-09-18"},{"description":{"content":"

Return failed calls

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

Filter results to just CDRs to a specific DID

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

Filter results to just CDRs from a specific DID

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

Get results in CSV form

\n","type":"text/plain"},"key":"csv","value":""}],"variable":[]}},"response":[{"id":"0a054cc0-1943-49e3-938c-42cae4e784f3","name":"Untitled Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.thinq.com/outbound/cdrs?rowsPerPage=25¤tPage=1&sort=desc&dateStart=2020-09-17&dateEnd=2020-09-18&failed=true&didTo=9192687435&didFrom=3056789120&csv=","host":["https://api.thinq.com"],"path":["outbound","cdrs"],"query":[{"key":"rowsPerPage","value":"25"},{"key":"currentPage","value":"1"},{"key":"sort","value":"desc"},{"key":"dateStart","value":"2020-09-17"},{"key":"dateEnd","value":"2020-09-18"},{"key":"failed","value":"true"},{"key":"didTo","value":"9192687435"},{"key":"didFrom","value":"3056789120"},{"key":"csv","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"fromDid\": \"18585550003\",\n \"toDid\": \"16785556677\",\n \"lrn\": \"17702259988\",\n \"callId\": \"1b8f01bd1c60ab0279f474040f8f18f7@192.0.0.1:5000\",\n \"date\": \"09/17/2020\",\n \"time\": \"2020-09-17 13:07:00\",\n \"carrierId\": 48,\n \"accountId\": 3201,\n \"srcIp\": \"192.0.0.1\",\n \"profileId\": 9316,\n \"retail\": 0.002597,\n \"billable\": 12,\n \"totalRetail\": 0.000519,\n \"fromState\": \"CA\",\n \"toState\": \"GA\",\n \"fromRc\": \"DEL MAR\",\n \"toRc\": \"ATLANTA NE\",\n \"fromLata\": \"732\",\n \"toLata\": \"438\",\n \"fromOcn\": \"981E\",\n \"toOcn\": \"7435\",\n \"jurisdiction\": \"E\",\n \"sipCode\": \"486\",\n \"sipReason\": \"Busy Here\"\n },\n {\n \"fromDid\": \"18585550003\",\n \"toDid\": \"16785556677\",\n \"lrn\": \"17702259988\",\n \"callId\": \"1b8f01bd1c60ab0279f474040f8f18f7@192.0.0.1:5000\",\n \"date\": \"09/17/2020\",\n \"time\": \"2020-09-17 13:07:00\",\n \"carrierId\": 48,\n \"accountId\": 3201,\n \"srcIp\": \"192.0.0.1\",\n \"profileId\": 9316,\n \"retail\": 0.002597,\n \"billable\": 12,\n \"totalRetail\": 0.000519,\n \"fromState\": \"CA\",\n \"toState\": \"GA\",\n \"fromRc\": \"DEL MAR\",\n \"toRc\": \"ATLANTA NE\",\n \"fromLata\": \"732\",\n \"toLata\": \"438\",\n \"fromOcn\": \"981E\",\n \"toOcn\": \"7435\",\n \"jurisdiction\": \"E\",\n \"sipCode\": \"486\",\n \"sipReason\": \"Busy Here\"\n }\n ],\n \"totalRows\": 1,\n \"rowsPerPage\": 25,\n \"hasPrevPage\": false,\n \"hasNextPage\": true,\n \"currentPage\": 1,\n \"totalPages\": 1\n}"}],"_postman_id":"6d91f805-f4ad-4f2f-94d9-95c9fd33d881"}],"id":"97053a43-462d-4002-9fb8-c91398c7f11d","_postman_id":"97053a43-462d-4002-9fb8-c91398c7f11d","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"Daily International Spend","item":[{"name":"/daily-international-spend","id":"22d981ca-13c7-499e-9e9c-a074f95ce092","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/daily-international-spend","description":"

Get current international spend as well as maximum daily international spend.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["daily-international-spend"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"a15b3b21-680d-424b-989f-97367445bf6a","name":"Untitled Example","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/daily-international-spend"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"dailyIntlSpendLimit\": 100,\n \"currentIntlSpend\": 50\n}"}],"_postman_id":"22d981ca-13c7-499e-9e9c-a074f95ce092"},{"name":"/daily-international-spend/reset","id":"1b2fe587-f9ef-402a-a272-9876775f0b47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"{{baseUrl}}/daily-international-spend/reset","description":"

Reset current international spend to 0 for the day.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["daily-international-spend","reset"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"59bba4cd-4e55-432e-8f54-7ae4b3a6e572","name":"Untitled Example","originalRequest":{"method":"PUT","header":[],"url":"{{baseUrl}}/daily-international-spend/reset"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\"\n}"}],"_postman_id":"1b2fe587-f9ef-402a-a272-9876775f0b47"}],"id":"e7f989ce-1522-4f7f-9a5e-f6dc32470744","event":[{"listen":"prerequest","script":{"id":"4b0ee243-49ae-4b01-bfd2-996abb2e6cbd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0c51696d-bde7-4826-bb29-a8c5de0bbbf2","type":"text/javascript","exec":[""]}}],"_postman_id":"e7f989ce-1522-4f7f-9a5e-f6dc32470744","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"Payment Info","item":[{"name":"Auto Bill","item":[{"name":"/paymentinfo/autobill/enable","id":"2eb453ab-f0cf-47d8-bf16-dfc019306b34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Smith\",\n \"cardNumber\": \"4012888888881881\",\n \"expiration\": \"05/30\",\n \"cvv\": \"321\",\n \"depositAmount\": 500,\n \"softLimit\": 100\n}"},"url":"{{baseUrl}}/paymentinfo/autobill/enable","description":"

Enable automatic payments for your account

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["paymentinfo","autobill","enable"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"4baf9842-65e0-4b24-bdf6-b95695f9adbf","name":"Default Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"John Smith\",\n \"cardNumber\": \"4012888888881881\",\n \"expiration\": \"05/30\",\n \"cvv\": \"321\",\n \"depositAmount\": 500,\n \"softLimit\": 100\n}"},"url":"{{baseUrl}}/paymentinfo/autobill/enable"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"2eb453ab-f0cf-47d8-bf16-dfc019306b34"},{"name":"/paymentinfo/autobill/disable","id":"8b48fb3f-3271-48b8-8fa4-6bf2b15c1da7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{baseUrl}}/paymentinfo/autobill/disable","description":"

Disable automatic payments for your account

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["paymentinfo","autobill","disable"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"b785050c-4195-43a8-b0ca-708d4bbfbbe8","name":"Default Response","originalRequest":{"method":"POST","header":[],"url":"{{baseUrl}}/paymentinfo/autobill/disable"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8b48fb3f-3271-48b8-8fa4-6bf2b15c1da7"}],"id":"400a7dd6-d26e-4c86-907e-0c5103e63803","_postman_id":"400a7dd6-d26e-4c86-907e-0c5103e63803","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"/paymentinfo","id":"a1bd6409-4fda-4aa1-9226-d775bd1aaf31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/paymentinfo","description":"

Get payment information associated with your account

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["paymentinfo"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"d66763f0-1ab5-47d9-8fc5-fdf69db01168","name":"Untitled Example","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/paymentinfo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"paymentType\": \"postpaid\",\n \"autoBill\": {\n \"softLimit\": 25,\n \"intlSoftLimit\": 50,\n \"hardLimit\": 10,\n \"intlHardLimit\": 15,\n \"autoDeposit\": 0,\n \"depositAmount\": 250\n },\n \"creditCard\": {\n \"ccLastFourDigits\": 1234,\n \"ccName\": \"John Doe\",\n \"ccExpirationMonth\": \"05\",\n \"ccExpirationYear\": \"2020\"\n },\n \"billingAddress\": {\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 2\",\n \"city\": \"Raleigh\",\n \"state\": \"NC\",\n \"zipcode\": \"27513\",\n \"phone\": \"9195552929\"\n }\n}"}],"_postman_id":"a1bd6409-4fda-4aa1-9226-d775bd1aaf31"},{"name":"/paymentinfo/billingaddress","id":"8fbb0a60-087c-41ae-b74c-dab503146b54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 2\",\n \"city\": \"Raleigh\",\n \"state\": \"NC\",\n \"zipcode\": \"27513\",\n \"phone\": \"9195552929\"\n}"},"url":"{{baseUrl}}/paymentinfo/billingaddress","description":"

Update the billing address for the logged in user's account

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["paymentinfo","billingaddress"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"2e2df32f-52fd-43e5-a03e-413a9420c140","name":"Successful response","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"address1\": \"123 Main St\",\n \"address2\": \"Suite 2\",\n \"city\": \"Raleigh\",\n \"state\": \"NC\",\n \"zipcode\": \"27513\",\n \"phone\": \"9195552929\"\n}"},"url":"{{baseUrl}}/paymentinfo/billingaddress"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"accountId\": 1\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"8fbb0a60-087c-41ae-b74c-dab503146b54"}],"id":"a47e37b0-7b60-43b8-93e1-50ee7d365afe","_postman_id":"a47e37b0-7b60-43b8-93e1-50ee7d365afe","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"Invoices","item":[{"name":"/invoices","id":"57f3a6df-6c8b-4ab1-b499-54249f8fa9b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/invoices?rowsPerPage=25¤tPage=1","description":"

Get all invoices belonging to the authenticated user's account

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["invoices"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

(Required)

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

(Required)

\n","type":"text/plain"},"key":"currentPage","value":"1"}],"variable":[]}},"response":[{"id":"5ac69977-0a81-4ed4-b2f8-91fc9a1b8b30","name":"Untitled Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/invoices?rowsPerPage=25¤tPage=1","host":["{{baseUrl}}"],"path":["invoices"],"query":[{"key":"rowsPerPage","value":"25"},{"key":"currentPage","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"invoiceId\": \"12345\",\n \"amount\": \"15.77\",\n \"date\": \"2011-06-04 00:00:00\",\n \"invoiceNumber\": \"12020\",\n \"product\": \"Outbound\",\n \"status\": \"auto-paid\",\n \"url\": \"https://example.freshbooks.com/view/\"\n },\n {\n \"invoiceId\": \"12345\",\n \"amount\": \"15.77\",\n \"date\": \"2011-06-04 00:00:00\",\n \"invoiceNumber\": \"12020\",\n \"product\": \"Outbound\",\n \"status\": \"auto-paid\",\n \"url\": \"https://example.freshbooks.com/view/\"\n }\n ],\n \"totalRows\": 1,\n \"rowsPerPage\": 25,\n \"hasPrevPage\": false,\n \"hasNextPage\": true,\n \"currentPage\": 1,\n \"totalPages\": 1\n}"}],"_postman_id":"57f3a6df-6c8b-4ab1-b499-54249f8fa9b8"},{"name":"/invoices","id":"9cceb0b0-17f4-4b13-98aa-10e394f21de8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{baseUrl}}/invoices?amount=100","description":"

Create a payment invoice belonging to the authenticated user's account

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["invoices"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"key":"amount","value":"100"}],"variable":[]}},"response":[{"id":"a8eafea2-fa37-411a-b196-41e78585566c","name":"Untitled Example","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/invoices?amount=100","host":["{{baseUrl}}"],"path":["invoices"],"query":[{"key":"amount","value":"100"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"invoiceId\": 78189349.88353613,\n \"invoiceUrl\": \"https://thinqinvoice.freshbooks.com/view/3uxcEsGq\",\n \"invoiceNumber\": -78842197.36532173\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"9cceb0b0-17f4-4b13-98aa-10e394f21de8"},{"name":"/invoices/payments/:id","id":"40b2f2af-bde7-4af8-b522-8cb6cef1f11f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/invoices/payments/:id","description":"

Get payments and payments' information of an invoice

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["invoices","payments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"2ab9dec8-0e34-4208-93d1-9fe3a9a12c4a","description":{"content":"

(Required) ID of the trunk to retrieve

\n","type":"text/plain"},"type":"string","value":"1","key":"id"}]}},"response":[{"id":"2288cd7c-253b-44f3-9102-0c2ea73a3aaf","name":"Successful response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/invoices/payments/:id","host":["{{baseUrl}}"],"path":["invoices","payments",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"date\": \"2011-06-04 00:00:00\",\n \"updated\": \"2011-06-05 01:01:01\",\n \"amount\": \"0.00\",\n \"type\": \"ACH\",\n \"notes\": \"Rebate\"\n },\n {\n \"date\": \"2011-06-04 00:00:00\",\n \"updated\": \"2011-06-05 01:01:01\",\n \"amount\": \"0.00\",\n \"type\": \"ACH\",\n \"notes\": \"Rebate\"\n }\n]"}],"_postman_id":"40b2f2af-bde7-4af8-b522-8cb6cef1f11f"}],"id":"61e2e0d1-f366-45e1-8c82-63c355246758","_postman_id":"61e2e0d1-f366-45e1-8c82-63c355246758","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"Notifications","item":[{"name":"/notifications","id":"c07f0dc7-f1db-4948-b42c-58c2afd4a6bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/notifications","description":"

Get information needed to send notifications

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["notifications"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"18453ac3-12ef-48c6-ba8c-4971e29ca7b3","name":"Default Response","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/notifications"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c07f0dc7-f1db-4948-b42c-58c2afd4a6bc"},{"name":"/notifications","id":"93e6f4e1-b890-4186-98ac-b97bf53138e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"notificationSettings\",\n \"notifications\": {\n \"inboundBalance\": {\n \"threshold\": 65490477.633123904,\n \"active\": false\n },\n \"outboundBalance\": {\n \"threshold\": -57185460.61926304,\n \"active\": true\n },\n \"dailyInternationalSpend\": {\n \"threshold\": -83185766.30256814,\n \"active\": true\n },\n \"accountSuspended\": {\n \"active\": true\n },\n \"pastDueBill\": {\n \"active\": true\n },\n \"creditCardExpired\": {\n \"active\": true\n }\n }\n}"},"url":"{{baseUrl}}/notifications","description":"

Creating a new notifications document for an account

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["notifications"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"3626c825-0fc7-43b6-adda-39088d1da743","name":"Untitled Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"notificationSettings\",\n \"notifications\": {\n \"inboundBalance\": {\n \"threshold\": 65490477.633123904,\n \"active\": false\n },\n \"outboundBalance\": {\n \"threshold\": -57185460.61926304,\n \"active\": true\n },\n \"dailyInternationalSpend\": {\n \"threshold\": -83185766.30256814,\n \"active\": true\n },\n \"accountSuspended\": {\n \"active\": true\n },\n \"pastDueBill\": {\n \"active\": true\n },\n \"creditCardExpired\": {\n \"active\": true\n }\n }\n}"},"url":"{{baseUrl}}/notifications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 100\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"93e6f4e1-b890-4186-98ac-b97bf53138e5"},{"name":"/notifications/:id","id":"216fe983-b44f-4046-8f20-0673f614e1ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 11001,\n \"type\": \"notificationSettings\",\n \"notifications\": {\n \"inboundBalance\": {\n \"threshold\": 50,\n \"sent\": false,\n \"users\": [\n \"tatkins11001\",\n \"aclarke11001\"\n ]\n },\n \"outboundBalance\": {\n \"threshold\": 100,\n \"sent\": false,\n \"users\": [\n \"tatkins11001\"\n ]\n },\n \"accountSuspended\": {\n \"sent\": false,\n \"users\": [\n \"admin11001\"\n ]\n }\n }\n}"},"url":"{{baseUrl}}/notifications/:id","description":"

Updating notification settings by the ID using the body of the put request

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}},"urlObject":{"path":["notifications",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"396c6a62-cfbe-4916-8e00-cd365f298de9","description":{"content":"

(Required) ID of the account that wants to update its notification settings

\n","type":"text/plain"},"type":"string","value":"100","key":"id"}]}},"response":[{"id":"0b8feeae-bde9-4e77-bc41-3df6adb5118b","name":"Untitled Example","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 11001,\n \"type\": \"notificationSettings\",\n \"notifications\": {\n \"inboundBalance\": {\n \"threshold\": 50,\n \"sent\": false,\n \"users\": [\n \"tatkins11001\",\n \"aclarke11001\"\n ]\n },\n \"outboundBalance\": {\n \"threshold\": 100,\n \"sent\": false,\n \"users\": [\n \"tatkins11001\"\n ]\n },\n \"accountSuspended\": {\n \"sent\": false,\n \"users\": [\n \"admin11001\"\n ]\n }\n }\n}"},"url":{"raw":"{{baseUrl}}/notifications/:id","host":["{{baseUrl}}"],"path":["notifications",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 100\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"216fe983-b44f-4046-8f20-0673f614e1ef"}],"id":"784e866b-c9a3-4a77-9592-bb7b5f5c4ab7","_postman_id":"784e866b-c9a3-4a77-9592-bb7b5f5c4ab7","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"CDR download","item":[{"name":"Migrating from FTP downloads","item":[],"id":"17524431-3d0f-4b9d-a1a7-c5dd3d31b7ca","description":"

The HTTP method for downloading CDRs will replace the current FTP method of doing so. In order to ease out the process, this is a comparison of how each step must be accomplisehd using the HTTP methods vs how it was done using FTP.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Action	FTP commands	HTTP request
List years with available CDRs	`ls`	`GET https://api.thinq.com/outbound/cdrs/download` Documentation
List months with available CDRs	`cd {{year}}` (Example: `cd 2014`) `ls` (retrieves directories, each one being a month)	`GET https://api.thinq.com/outbound/cdrs/download/{{year}}` (Example: `GET https://api.thinq.com/outbound/cdrs/download/2014`) Documentation
List days with available CDRs	`cd {{month}}` (Example: `cd 10`) `ls` (retrieves the filenames, each one being a day)	`GET https://api.thinq.com/outbound/cdrs/download/{{year}}/{{month}}` (Example: `GET https://api.thinq.com/outbound/cdrs/download/2014/10`) Documentation
List jurisdictions (either `domestic` or `international` with available CDRs for a day		`GET https://api.thinq.com/outbound/cdrs/download/{{year}}/{{month}}/{{day}}` (Example: `GET https://api.thinq.com/outbound/cdrs/download/2014/10/04`) Documentation
Retrieve CDRs file	`get {{filename}}`(Example: `get 2014-10-21_cdr.zip`)	`GET https://api.thinq.com/outbound/cdrs/download/{{year}}/{{month}}/{{day}}/{{jurisdiction}})` (Example: `GET https://api.thinq.com/outbound/cdrs/download/2014/10/21/domestic`). Documentation

","_postman_id":"17524431-3d0f-4b9d-a1a7-c5dd3d31b7ca","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}},{"name":"Get list of available years","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"aaac2c0c-34a7-4a69-9ddc-fc741c68c5ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/outbound/cdrs/download","description":"

Provides a list of all years with at least one day of CDRs available for download.

\n","urlObject":{"path":["outbound","cdrs","download"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"3168884b-1d46-49ac-bfbb-e1a3d4a86cd3","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/outbound/cdrs/download"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\"2021\",\"2022\",\"2023\",\"2024\"]"}],"_postman_id":"aaac2c0c-34a7-4a69-9ddc-fc741c68c5ed"},{"name":"Get list of available months","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"becb0617-0acb-4942-a53f-c7ddbfd466a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/outbound/cdrs/download/{{year}}","description":"

Provides a list of all months within the given year with at least one day of CDRs available for download.

\n","urlObject":{"path":["outbound","cdrs","download","{{year}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"e7f95c6b-0cd5-4cf0-9e83-f1f3922a69b5","name":"Example for a given year","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/outbound/cdrs/download/{{year}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\"01\",\"02\",\"03\",\"04\",\"06\",\"07\",\"08\",\"09\",\"10\",\"11\",\"12\"]"}],"_postman_id":"becb0617-0acb-4942-a53f-c7ddbfd466a4"},{"name":"Get list of available days","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"8e900b9c-9e6e-403d-a904-816252dac8a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/outbound/cdrs/download/{{year}}/{{month}}","description":"

Provides a list of all days within the given year and month with at least one day of CDRs available for download.

\n","urlObject":{"path":["outbound","cdrs","download","{{year}}","{{month}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"84fec3c4-578c-45a2-8bcb-c30bd59e2dd0","name":"Example for a given year and month","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/outbound/cdrs/download/{{year}}/{{month}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\"06\",\"07\",\"08\",\"11\",\"13\",\"20\",\"21\",\"22\",\"25\"]"}],"_postman_id":"8e900b9c-9e6e-403d-a904-816252dac8a2"},{"name":"Get list of available jurisdictions","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"8491dd30-feb6-40ac-9d8b-de200cc80de4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/outbound/cdrs/download/{{year}}/{{month}}/{{day}}","description":"

Provides a list of all jurisdictions within the given year, month and day with at least one entry available for download.

\n","urlObject":{"path":["outbound","cdrs","download","{{year}}","{{month}}","{{day}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"7dadf7ba-b411-4e11-96df-34ffafa39229","name":"Example for a given year, month and day","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/outbound/cdrs/download/{{year}}/{{month}}/{{day}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\"domestic\", \"intl\"]"}],"_postman_id":"8491dd30-feb6-40ac-9d8b-de200cc80de4"},{"name":"Download CDRs for a given date","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"ef56d839-43af-4e40-885d-ac6d3d1fc28a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/outbound/cdrs/download/{{year}}/{{month}}/{{day}}/{{jurisdiction}}","description":"

Returns a 302 response that points to the URL for downloading the GZipped CSV file containing all CDRs for the given date. This URL is only valid for one minute: a GET request to that URL has to be done within one ominute, otherwise the download won't be available.

\n","urlObject":{"path":["outbound","cdrs","download","{{year}}","{{month}}","{{day}}","{{jurisdiction}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"e2ad8a7d-69d9-424b-92d4-e82664a95dd6","name":"Example for a given year and month","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/outbound/cdrs/download/{{year}}/{{month}}/{{day}}/{{jurisdiction}}"},"status":"Found","code":302,"_postman_previewlanguage":"Text","header":[{"key":"Location","value":"https://storage.googleapis.com/mdrs/123/2015/10/2015-10-21_cdr_123.csv.zip?signature=abc","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ef56d839-43af-4e40-885d-ac6d3d1fc28a"}],"id":"7676efdb-a752-465c-acb3-5cffb374cca0","description":"

This group of resources is intended for discovering every date with available CDRs and providing a download link for a GZipped CSV file containing all CDRs for each date.

\n","_postman_id":"7676efdb-a752-465c-acb3-5cffb374cca0","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","name":"Outbound","type":"folder"}}}],"id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"_postman_id":"894d6d42-c7c7-4f3a-8bbc-09dad6549b07","description":""},{"name":"Inbound","item":[{"name":"CNAM Out","item":[{"name":"List Existing CNAM Profiles ","event":[{"listen":"prerequest","script":{"id":"7b7dc403-cce8-4ed9-b53a-600a08a8e76f","type":"text/javascript","exec":["//postman.setGlobalVariable('randomName', Math.floor(Math.random(1) * 999999));"]}},{"listen":"test","script":{"id":"64409035-fd1b-436a-a808-02fa064c7088","type":"text/javascript","exec":[""]}}],"id":"1e0990c5-4f1f-4990-98f8-cb6041087907","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.thinq.com/account/{{account_id}}/caller_id","description":"\nRetrieve a list of all the existing CNAM out profiles associated with your account.","urlObject":{"path":["account","{{account_id}}","caller_id"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"19f98661-1590-4a0b-ab19-15ecb808e531","name":"List Existing CNAM Profiles ","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/caller_id"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total_rows\": 14,\n \"has_next_page\": true,\n \"page\": 1,\n \"rows_per_page\": 2,\n \"rows\": [\n {\n \"name\": \"Business Name\",\n \"caller_id_type\": \"business\",\n \"id\": 81678\n },\n {\n \"first_name\": \"FirstName\",\n \"last_name\": \"LastName\",\n \"caller_id_type\": \"residential\",\n \"id\": 81679\n }\n ]\n}\n"}],"_postman_id":"1e0990c5-4f1f-4990-98f8-cb6041087907"},{"name":"Retrieve Single CNAM Profile","event":[{"listen":"test","script":{"id":"202c7bd3-512b-459f-955a-bbfd52c64c60","type":"text/javascript","exec":[""]}}],"id":"33405895-e958-40e9-8c26-89b73da981d0","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.thinq.com/account/{{account_id}}/caller_id/{{cnamout_profile_id}}","description":"

Use this to get the details for a specific CNAM out profile.

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":"Residential:\n{\n \"AccountCallerId\": {\n \"caller_id_type\": \"residential\",\n \"first_name\": \"FirstName\",\n \"last_name\": \"LastName\"\n }\n} (JSON, BODY)\n\nBusiness:\n{\n \"AccountCallerId\": {\n \"name\": \"Business Name\",\n \"caller_id_type\": \"business\"\n }\n} "},"url":"https://api.thinq.com/account/{{account_id}}/caller_id/","description":"

Generate a new CNAM out profile.

\n","urlObject":{"path":["account","{{account_id}}","caller_id",""],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"05f9c12a-9513-4432-865f-fb97ee51028f","name":"Create New CNAM Profile","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}"}],"body":{"mode":"raw","raw":"{\n \"AccountCallerId\": {\n \"caller_id_type\": \"residential\",\n \"first_name\": \"thinQ-first_name\",\n \"last_name\": \"thinQ-last_name\"\n }\n} "},"url":"https://api.thinq.com/account/{{account_id}}/caller_id/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"Residential:\n{\n \"first_name\": \"FirstName\",\n \"last_name\": \"LastName\",\n \"caller_id_type\": \"residential\",\n \"account_id\": XX,\n \"id\": XXX,\n \"type\": \"caller_id\"\n}\n\nBusiness:\n{\n \"name\": \"Business Name\",\n \"caller_id_type\": \"business\",\n \"account_id\": XX,\n \"id\": XXX,\n \"type\": \"caller_id\"\n}"}],"_postman_id":"4fec4fa6-fd69-41a4-a09e-159120401042"},{"name":"Update Existing CNAM Profile","event":[{"listen":"test","script":{"id":"372acbd7-1cb8-454f-b258-c48ca746722d","type":"text/javascript","exec":[""]}}],"id":"cdfca759-45b6-48f7-8b0a-40ddab29a47e","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":"Residential:\n{\n \"AccountCallerId\": {\n \"first_name\": \"FirstName\",\n \"last_name\": \"LastName\",\n \"caller_id_type\": \"residential\",\n \"type\": \"caller_id\"\n }\n} (JSON, BODY)\n\nBusiness:\n{\n \"AccountCallerId\": {\n \"name\": \"Business Name\",\n \"caller_id_type\": \"business\",\n \"type\": \"caller_id\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/caller_id/{{cnamout_profile_id}}","description":"

Update the details for an existing CNAM out profile.

\n","urlObject":{"path":["account","{{account_id}}","caller_id","{{cnamout_profile_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"7086a478-8086-4ba6-8ff4-3d352ad93959","name":"Update Existing CNAM Profile","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":"Residential:\n{\n \"AccountCallerId\": {\n \"first_name\": \"FirstName\",\n \"last_name\": \"LastName\",\n \"caller_id_type\": \"residential\",\n \"type\": \"caller_id\"\n }\n} (JSON, BODY)\n\nBusiness:\n{\n \"AccountCallerId\": {\n \"name\": \"Business Name\",\n \"caller_id_type\": \"business\",\n \"type\": \"caller_id\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/caller_id/{{cnamout_profile_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"Residential:\n{\n \"first_name\": \"FirstName\",\n \"last_name\": \"LastName\",\n \"caller_id_type\": \"residential\",\n \"account_id\": \"XX\",\n \"id\": XXX,\n \"type\": \"caller_id\"\n}\n\nBusiness:\n{\n \"name\": \"Business Name\",\n \"caller_id_type\": \"business\",\n \"account_id\": \"XX\",\n \"id\": XXX,\n \"type\": \"caller_id\"\n}"}],"_postman_id":"cdfca759-45b6-48f7-8b0a-40ddab29a47e"}],"id":"3c89a0d1-f7f5-484c-a031-dc171472433b","event":[{"listen":"prerequest","script":{"id":"9e156dea-8266-4865-aba7-6fc946db652c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2e07b461-d0d3-41d4-bcfb-57280361a928","type":"text/javascript","exec":[""]}}],"_postman_id":"3c89a0d1-f7f5-484c-a031-dc171472433b","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"e911","item":[{"name":"List Existing IP Addresses","event":[{"listen":"test","script":{"id":"fe159df8-d342-4111-a68e-132213453b72","type":"text/javascript","exec":[""]}}],"id":"dbaf7505-3736-4a48-b959-58bbd30366a9","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/account/{{account_id}}/product/origination/e911/ip","description":"

Use this to get a list of all your IP addresses associated with e911 locations.

\n","urlObject":{"path":["account","{{account_id}}","product","origination","e911","ip"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"141a6826-3320-4c8a-9795-24406a77576d","name":"List Existing e911 IP Addresses","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/e911/ip"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total_rows\": 2,\n \"has_next_page\": true,\n \"page\": 1,\n \"rows_per_page\": 1,\n \"rows\": [\n {\n \"ip\": \"XX.XX.XX.XX\"\n }\n ]\n}"}],"_postman_id":"dbaf7505-3736-4a48-b959-58bbd30366a9"},{"name":"Create New IP Address","event":[{"listen":"test","script":{"id":"66067235-69d8-41dd-9e69-8aa11f46a5b1","type":"text/javascript","exec":[""]}},{"listen":"prerequest","script":{"id":"73f19858-310f-4e6f-8706-349959c4b3bf","type":"text/javascript","exec":[""]}}],"id":"96da71cf-5843-4d2b-8d5f-445ad176bcef","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/account/{{account_id}}/product/origination/e911/ip/{{e911_oldIP}}","description":"

Use this to set up a new e911 IP address.

\n","urlObject":{"path":["account","{{account_id}}","product","origination","e911","ip","{{e911_oldIP}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"75633b5e-2822-4d71-8570-87bf77b3a5df","name":"Create New IP Address","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/e911/ip/{{e911_oldIP}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"assigned_IPs\": [\n {\n \"account_id\": [\n 10\n ],\n \"id\": \"XX.XX.XX.XX\",\n \"type\": \"ip_e911\"\n }\n ]\n}"}],"_postman_id":"96da71cf-5843-4d2b-8d5f-445ad176bcef"},{"name":"Delete Existing IP Address","event":[{"listen":"test","script":{"id":"2532ed13-f132-4ec3-a786-6bfd24ee2220","type":"text/javascript","exec":[""]}}],"id":"658b50eb-5d94-4438-91fb-943f4488f6ab","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic Y2hvc2tpbnM6ODg0NDM1MjQ0YWVhYjc2NTU5ZTQzYjcwNTJjMzVhN2M1OGYwZTk3Mw=="}],"url":"https://api.thinq.com/account/{{account_id}}/product/origination/e911/ip/{{e911_newIP}}","description":"

Use this to delete an existing e911 IP address.

\n","urlObject":{"path":["account","{{account_id}}","product","origination","e911","ip","{{e911_newIP}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"77c1cd69-3417-4d31-be3b-e6f60bcb22c0","name":"Delete Existing IP Address","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/e911/ip/{{e911_newIP}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"200 http code"}],"_postman_id":"658b50eb-5d94-4438-91fb-943f4488f6ab"},{"name":"Update Existing IP Address","event":[{"listen":"test","script":{"id":"80f3dc3f-f612-434e-9b62-dca288a2dfe7","type":"text/javascript","exec":[""]}}],"id":"6b3a3f5e-097a-4d3e-a845-b4a03c0a2a11","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/e911/ip/{{e911_oldIP}}/newIP/{{e911_newIP}}","description":"

Use this to update an existing e911 IP address.

\n","urlObject":{"path":["account","{{account_id}}","product","origination","e911","ip","{{e911_oldIP}}","newIP","{{e911_newIP}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"9e4b1d65-6783-4217-ac97-2a29933935a7","name":"Update Existing IP Address","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/e911/ip/{{e911_oldIP}}/newIP/{{e911_newIP}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6b3a3f5e-097a-4d3e-a845-b4a03c0a2a11"},{"name":"Retrieve Single Site","event":[{"listen":"test","script":{"exec":["//tests[\"Status code is 200 OK\"] = responseCode.code >= 200 && < 400;","//var jsonData = JSON.parse(responseBody);",""],"id":"cb42c53e-6e34-4a26-8815-7237df9aec27","type":"text/javascript"}}],"id":"3e3ab5aa-4c88-45ff-8596-855c7a56d0f3","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/account/{{account_id}}/location/{{e911_location_id}}","urlObject":{"path":["account","{{account_id}}","location","{{e911_location_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"f41f11d7-581f-4cdc-861c-94408a84199b","name":"Retrieve Single Site","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/location/{{e911_location_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"location_type\": \"business\",\n \"alias\": \"thinQ, Inc.\",\n \"country\": \"USA\",\n \"address\": \"5420 Wade Park Blvd\",\n \"address2\": \"Suite #100\",\n \"state\": \"NC\",\n \"zip\": \"27607\",\n \"account_id\": XX,\n \"id\": 62,\n \"subscriberID\": null,\n \"type\": \"account_location\",\n \"city\": \"Raleigh\"\n}"}],"_postman_id":"3e3ab5aa-4c88-45ff-8596-855c7a56d0f3"},{"name":"List Existing Sites","event":[{"listen":"test","script":{"id":"f61874e3-8e62-44a8-9b17-93f591d8b2b9","type":"text/javascript","exec":[""]}}],"id":"256757d2-748b-430c-90dd-15ec57b8a38f","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/account/{{account_id}}/location/","description":"

Retrieve a list of all the existing e911 locations for your account.

\n","urlObject":{"path":["account","{{account_id}}","location",""],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"bf7041dc-834a-4cb7-aef6-9f3099f71433","name":"List Existing Sites","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/location/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total_rows\": 19,\n \"has_next_page\": true,\n \"page\": 1,\n \"rows_per_page\": 1,\n \"rows\": [\n {\n \"location_type\": \"business\",\n \"alias\": \"thinQ, Inc.\",\n \"country\": \"USA\",\n \"address\": \"5420 Wade Park Blvd\",\n \"address2\": \"Suite #100\",\n \"state\": \"NC\",\n \"zip\": \"27607\",\n \"account_id\": XX,\n \"id\": 62,\n \"subscriberID\": [\n \"919XXXXXXX\",\n \"919XXXXXXX\"\n ],\n \"erlID\": \"1477AE9D-1A5A-44DA-BD16-47480E019814\",\n \"usedBy\": [\n 414XXXXXXX\n ],\n \"type\": \"account_location\",\n \"city\": \"Raleigh\"\n }\n ]\n}"}],"_postman_id":"256757d2-748b-430c-90dd-15ec57b8a38f"},{"name":"Create New Site","event":[{"listen":"test","script":{"id":"079ea8b2-f649-4765-bff0-b871c7cb0bb9","type":"text/javascript","exec":[""]}}],"id":"b5b9ef48-10b6-4d27-ba14-41d5f663913e","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":"{\n \"account_id\": {{account_id}},\n \"location\": {\n \"alias\": \"thinQ, Inc. Postman Test\",\n \"location_type\": \"business\",\n \"address\": \"5420 Wade Park Blvd\",\n \"address2\": \"Suite 100\",\n \"country\": \"USA\",\n \"city\": \"Raleigh\",\n \"zip\": \"27607\",\n \"state\": \"NC\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/location/","description":"

Use this to create a new e911 location record.

\n","urlObject":{"path":["account","{{account_id}}","location",""],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"e58c33b7-afbe-48bf-b51a-a31c10f1ba7f","name":"Create New Site","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":"{\n \"account_id\": {{account_id}},\n \"location\": {\n \"alias\": \"thinQ, Inc. Postman Test\",\n \"location_type\": \"business\",\n \"address\": \"5420 Wade Park Blvd\",\n \"address2\": \"Suite 100\",\n \"country\": \"USA\",\n \"city\": \"Raleigh\",\n \"zip\": \"27607\",\n \"state\": \"NC\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/location/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"account_id\": \"XX\",\n \"location\": {\n \"alias\": \"thinQ, Inc.\",\n \"location_type\": \"business\",\n \"address\": \"5420 Wade Park Blvd\",\n \"address2\": \"Suite 100\",\n \"country\": \"USA\",\n \"city\": \"Raleigh\",\n \"zip\": \"27607\",\n \"state\": \"NC\"\n }\n}"}],"_postman_id":"b5b9ef48-10b6-4d27-ba14-41d5f663913e"},{"name":"Update Existing Site","event":[{"listen":"test","script":{"exec":["//tests[\"Status code is 200 OK\"] = responseCode.code >= 200 && < 400;","//var jsonData = JSON.parse(responseBody);",""],"id":"9d78fff7-6faa-41f3-afde-cbbc42d98f3a","type":"text/javascript"}}],"id":"6b05d776-fd04-418c-8e7c-b7a368a4e650","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":"{\n \"account_id\": {{account_id}},\n \"location_id\": {{e911_location_id}},\n \"location\": {\n \"alias\": \"thinQ, Inc. Updated Postman Test\",\n \"location_type\": \"business\",\n \"address\": \"5420 Wade Park Blvd\",\n \"address2\": \"Suite 100\",\n \"country\": \"USA\",\n \"city\": \"Raleigh\",\n \"zip\": \"27607\",\n \"state\": \"NC\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/location/{{e911_location_id}}","description":"

Use this to update the details for an existing e911 location record.

\n","urlObject":{"path":["account","{{account_id}}","location","{{e911_location_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"1975a7a3-b34c-4031-8950-3d3429f344d2","name":"Update Existing Site","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":"{\n \"account_id\": {{account_id}},\n \"location_id\": {{e911_location_id}},\n \"location\": {\n \"alias\": \"thinQ, Inc. Updated Postman Test\",\n \"location_type\": \"business\",\n \"address\": \"5420 Wade Park Blvd\",\n \"address2\": \"Suite 100\",\n \"country\": \"USA\",\n \"city\": \"Raleigh\",\n \"zip\": \"27607\",\n \"state\": \"NC\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/location/{{e911_location_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"account_id\": XX,\n \"location_id\": XXX,\n \"location\": {\n \"alias\": \"thinQ, Inc.\",\n \"location_type\": \"business\",\n \"address\": \"5420 Wade Park Blvd\",\n \"address2\": \"Suite 100\",\n \"country\": \"USA\",\n \"city\": \"Raleigh\",\n \"zip\": \"27607\",\n \"state\": \"NC\"\n }\n}"}],"_postman_id":"6b05d776-fd04-418c-8e7c-b7a368a4e650"},{"name":"Delete Existing Site","event":[{"listen":"test","script":{"exec":["//tests[\"Status code is 200 OK\"] = responseCode.code >= 200 && < 400;","//var jsonData = JSON.parse(responseBody);",""],"id":"47a3396f-3ffe-4143-9ed4-647a982b8c33","type":"text/javascript"}}],"id":"40e7ce97-6fbc-4806-b879-1ddd1078b4a7","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/account/{{account_id}}/location/{{e911_location_id}}","description":"

Use this to delete an existing e911 location record.

\n","urlObject":{"path":["account","{{account_id}}","location","{{e911_location_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"d872e109-4b7a-4d21-b937-5c9f5eaca38a","name":"Delete Existing Site","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/location/{{e911_location_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"200 http code"}],"_postman_id":"40e7ce97-6fbc-4806-b879-1ddd1078b4a7"}],"id":"d82769db-c40c-42cc-bbc6-1eb0c3919acf","event":[{"listen":"prerequest","script":{"id":"cd05e316-c6d2-4388-a675-fc45fd9e5bcb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a8020851-b317-4568-8001-bb3a13a342bf","type":"text/javascript","exec":[""]}}],"_postman_id":"d82769db-c40c-42cc-bbc6-1eb0c3919acf","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Searching","item":[{"name":"Search Toll Free Numbers","event":[{"listen":"test","script":{"id":"247640ef-f9e6-4b42-8e21-3373af331606","exec":["","","",""],"type":"text/javascript"}}],"id":"6e4adc5b-48d3-4f46-9c73-ad38ce94aaa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.thinq.com/inbound/get-numbers?searchType=tollfree&searchBy=&quantity=1&contiguous=false&npa=855&related=true","description":"

Use this to search for available tollfree numbers. These numbers can be purchased and configured using additional API resources. You can search for available tollfree numbers by specifying the searchType to be tollfree. A tollfree prefix can be provided to the npa param, but it is not required.

You can search up to 100 numbers by changing the value of the quantity parameter

*note: if searchType is tollfree, searchBy, nxx, state, rateCenter params must be empty.

\n","urlObject":{"path":["inbound","get-numbers"],"host":["https://api.thinq.com"],"query":[{"key":"searchType","value":"tollfree"},{"key":"searchBy","value":""},{"key":"quantity","value":"1"},{"key":"contiguous","value":"false"},{"key":"npa","value":"855"},{"description":{"content":"

Optional, defaults to true

\n","type":"text/plain"},"key":"related","value":"true"}],"variable":[]}},"response":[{"id":"5d22517a-ef30-4f31-899c-1be246dac3fe","name":"Search Toll Free Numbers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.thinq.com/inbound/get-numbers?searchType=tollfree&searchBy=&quantity=1&contiguous=false&npa=855&related=true&onNetOnly=true","host":["https://api.thinq.com"],"path":["inbound","get-numbers"],"query":[{"key":"searchType","value":"tollfree"},{"key":"searchBy","value":""},{"key":"quantity","value":"1"},{"key":"contiguous","value":"false"},{"key":"npa","value":"855"},{"key":"related","value":"true","description":"Optional, defaults to true"},{"key":"onNetOnly","value":"true","description":"Optional, defaults to false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\":\"success\",\n \"resultSet\":\"tollfree\",\n \"dids\":[\n { \n \"carrierName\":\"thinQ TF\",\n \"didSummary\":null,\n \"id\":18552681511,\n \"npanxx\": null,\n \"ratecenter\":null,\n \"state\":null,\n \"thinqTier\":null,\n \"match\":\"exact\"\n }\n ]\n}"}],"_postman_id":"6e4adc5b-48d3-4f46-9c73-ad38ce94aaa6"},{"name":"Search Domestic Numbers - NPA & NXX","event":[{"listen":"test","script":{"id":"332f5524-29cb-48e6-8f61-223c3d2a5405","exec":["","","pm.test(\"Rows Returned\", function () {"," var jsonData = pm.response.json();"," console.log(jsonData.rows[0]);"," "," pm.environment.set(\"selected_did\", JSON.stringify(jsonData.rows[0]));"," //pm.expect(jsonData.value).to.eql(100);","});","","",""],"type":"text/javascript"}}],"id":"6f51a49c-305a-4bba-93a1-b04dfb12d2ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.thinq.com/inbound/get-numbers?searchType=domestic&searchBy=npanxx&quantity=1&contiguous=false&npa=919&nxx=245&related=true&onNetOnly=false","description":"

Search for single or multiple phone numbers. You can search by the first 'n' digits and by specifying the searchType to be domestic and searchBy to be npanxx.

You can search up to 100 numbers by changing the value of the quantity parameter

*note: if searchBy is npanxx, state and rateCenter params must be empty.

\n","urlObject":{"path":["inbound","get-numbers"],"host":["https://api.thinq.com"],"query":[{"key":"searchType","value":"domestic"},{"key":"searchBy","value":"npanxx"},{"key":"quantity","value":"1"},{"key":"contiguous","value":"false"},{"key":"npa","value":"919"},{"key":"nxx","value":"245"},{"description":{"content":"

Optional, defaults to true

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

Optional, defaults to false

\n","type":"text/plain"},"key":"onNetOnly","value":"false"}],"variable":[]}},"response":[{"id":"a377c71d-8328-4656-a8d9-93ff8161b930","name":"Search Individual Numbers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"url":{"raw":"https://api.thinq.com/inbound/get-numbers?searchType=domestic&searchBy=npanxx&quantity=1&contiguous=false&npa=919&nxx=245&related=true&onNetOnly=true","host":["https://api.thinq.com"],"path":["inbound","get-numbers"],"query":[{"key":"searchType","value":"domestic"},{"key":"searchBy","value":"npanxx"},{"key":"quantity","value":"1"},{"key":"contiguous","value":"false"},{"key":"npa","value":"919"},{"key":"nxx","value":"245"},{"key":"related","value":"true","description":"Optional, defaults to true"},{"key":"onNetOnly","value":"true","description":"Optional, defaults to false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\":\"success\",\n \"resultSet\":\"domestic\",\n \"dids\":[\n { \n \"carrierName\":\"thinQ\",\n \"didSummary\":null,\n \"id\":19192450742,\n \"npanxx\":\"919245\",\n \"ratecenter\":\"HILLSBORGH\",\n \"state\":\"NC\",\n \"thinqTier\":0,\n \"match\":\"exact\"\n }\n ]\n}"}],"_postman_id":"6f51a49c-305a-4bba-93a1-b04dfb12d2ef"},{"name":"Search Domestic Numbers - NPA","event":[{"listen":"test","script":{"id":"332f5524-29cb-48e6-8f61-223c3d2a5405","exec":["","","pm.test(\"Rows Returned\", function () {"," var jsonData = pm.response.json();"," console.log(jsonData.rows[0]);"," "," pm.environment.set(\"selected_did\", JSON.stringify(jsonData.rows[0]));"," //pm.expect(jsonData.value).to.eql(100);","});","","",""],"type":"text/javascript"}}],"id":"e511cbb8-9a7a-4d72-a732-f1cf06d8063e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.thinq.com/inbound/get-numbers?searchType=domestic&searchBy=npa&quantity=1&contiguous=false&npa=919&related=true&onNetOnly=false","description":"

Search for single or multiple phone numbers. You can search by area code and by specifying searchType to be domestic and searchBy to be npa.

You can search up to 100 numbers by changing the value of the quantity parameter

*note: If searchBy is npa, then nxx, state, and rateCenter params must be empty.

\n","urlObject":{"path":["inbound","get-numbers"],"host":["https://api.thinq.com"],"query":[{"key":"searchType","value":"domestic"},{"key":"searchBy","value":"npa"},{"key":"quantity","value":"1"},{"key":"contiguous","value":"false"},{"key":"npa","value":"919"},{"description":{"content":"

Optional, defaults to true

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

Optional, defaults to false

\n","type":"text/plain"},"key":"onNetOnly","value":"false"}],"variable":[]}},"response":[{"id":"410b1cae-81fb-4ad8-a876-f1271ebe0761","name":"Search Individual Numbers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"url":{"raw":"https://api.thinq.com/inbound/get-numbers?searchType=domestic&searchBy=npa&quantity=1&contiguous=false&npa=919&related=true&onNetOnly=true","host":["https://api.thinq.com"],"path":["inbound","get-numbers"],"query":[{"key":"searchType","value":"domestic"},{"key":"searchBy","value":"npa"},{"key":"quantity","value":"1"},{"key":"contiguous","value":"false"},{"key":"npa","value":"919"},{"key":"related","value":"true","description":"Optional, defaults to true"},{"key":"onNetOnly","value":"true","description":"Optional, defaults to false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\":\"success\",\n \"resultSet\":\"domestic\",\n \"dids\":[\n { \n \"carrierName\":\"thinQ\",\n \"didSummary\":null,\n \"id\":19192450742,\n \"npanxx\":\"919245\",\n \"ratecenter\":\"HILLSBORGH\",\n \"state\":\"NC\",\n \"thinqTier\":0,\n \"match\":\"exact\"\n }\n ]\n}"}],"_postman_id":"e511cbb8-9a7a-4d72-a732-f1cf06d8063e"},{"name":"Search Domestic Numbers - State & Rate Center","event":[{"listen":"test","script":{"id":"332f5524-29cb-48e6-8f61-223c3d2a5405","exec":["","","pm.test(\"Rows Returned\", function () {"," var jsonData = pm.response.json();"," console.log(jsonData.rows[0]);"," "," pm.environment.set(\"selected_did\", JSON.stringify(jsonData.rows[0]));"," //pm.expect(jsonData.value).to.eql(100);","});","","",""],"type":"text/javascript"}}],"id":"f2ec04b3-eaf0-41cd-948c-7b1e2ae2220e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.thinq.com/inbound/get-numbers?searchType=domestic&searchBy=ratecenter&quantity=1&contiguous=false&state=NC&rateCenter=RALEIGH&related=true&onNetOnly=false","description":"

Search for single or multiple phone numbers. You can search by state or by rate center by specifying searchType to be domestic and searchBy to be rateCenter.

You can search up to 100 numbers by changing the value of the quantity parameter

*note: If searchBy is ratecenter, then npa and nxx params must be empty. If you are searching for just the state only, then npa, nxx, and rateCenter params must be empty.

\n","urlObject":{"path":["inbound","get-numbers"],"host":["https://api.thinq.com"],"query":[{"key":"searchType","value":"domestic"},{"key":"searchBy","value":"ratecenter"},{"key":"quantity","value":"1"},{"key":"contiguous","value":"false"},{"key":"state","value":"NC"},{"key":"rateCenter","value":"RALEIGH"},{"description":{"content":"

Optional, defaults to true

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

Optional, defaults to false

\n","type":"text/plain"},"key":"onNetOnly","value":"false"}],"variable":[]}},"response":[{"id":"37f3c4a4-861b-45df-a206-470fe1bba4cf","name":"Search Individual Numbers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"url":{"raw":"https://api.thinq.com/inbound/get-numbers?searchType=domestic&searchBy=ratecenter&quantity=1&contiguous=false&state=NC&rateCenter=RALEIGH&related=true&onNetOnly=false","host":["https://api.thinq.com"],"path":["inbound","get-numbers"],"query":[{"key":"searchType","value":"domestic"},{"key":"searchBy","value":"ratecenter"},{"key":"quantity","value":"1"},{"key":"contiguous","value":"false"},{"key":"state","value":"NC"},{"key":"rateCenter","value":"RALEIGH"},{"key":"related","value":"true","description":"Optional, defaults to true"},{"key":"onNetOnly","value":"false","description":"Optional, defaults to false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\":\"success\",\n \"resultSet\":\"domestic\",\n \"dids\":[\n { \n \"carrierName\":\"thinQ\",\n \"didSummary\":null,\n \"id\":19192081339,\n \"npanxx\":\"919208\",\n \"ratecenter\":\"RALEIGH\",\n \"state\":\"NC\",\n \"thinqTier\":0,\n \"match\":\"exact\"\n }\n ]\n}"}],"_postman_id":"f2ec04b3-eaf0-41cd-948c-7b1e2ae2220e"},{"name":"Search Contiguous Blocks","event":[{"listen":"test","script":{"id":"2a3a2566-d9c2-4154-929d-6a8ed6df324c","exec":["","","",""],"type":"text/javascript"}}],"id":"b0d15399-62d1-42a3-a44d-ef8a3a20b204","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.thinq.com/inbound/get-numbers?searchType=domestic&searchBy=ratecenter&quantity=5&contiguous=true&state=NC&related=true&onNetOnly=true","description":"

Use this to search for blocks of sequential phone numbers. Numbers can be searched by state and rate center, by area code, and by the first three digits. Numbers will be returned in blocks of a minimum of 5. Search for contiguous blocks by changing the value of the contiguous parameter to true.

You can search up to 100 numbers by changing the value of the quantity parameter

\n","urlObject":{"path":["inbound","get-numbers"],"host":["https://api.thinq.com"],"query":[{"key":"searchType","value":"domestic"},{"key":"searchBy","value":"ratecenter"},{"key":"quantity","value":"5"},{"key":"contiguous","value":"true"},{"key":"state","value":"NC"},{"description":{"content":"

Optional, defaults to true

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

Optional, defaults to false

\n","type":"text/plain"},"key":"onNetOnly","value":"true"}],"variable":[]}},"response":[{"id":"f71fb9e1-02dc-480e-b05e-b0ddba464c7c","name":"Search Contiguous Blocks","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.thinq.com/inbound/get-numbers?searchType=domestic&searchBy=ratecenter&quantity=5&contiguous=true&state=NC&related=true&onNetOnly=false","host":["https://api.thinq.com"],"path":["inbound","get-numbers"],"query":[{"key":"searchType","value":"domestic"},{"key":"searchBy","value":"ratecenter"},{"key":"quantity","value":"5"},{"key":"contiguous","value":"true"},{"key":"state","value":"NC"},{"key":"related","value":"true","description":"Optional, defaults to true"},{"key":"onNetOnly","value":"false","description":"Optional, defaults to false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\":\"success\",\n \"resultSet\":\"domestic\",\n \"dids\":[\n { \n \"carrierName\":\"thinQ\",\n \"didSummary\":null,\n \"id\":19193008000,\n \"npanxx\":\"919300\",\n \"ratecenter\":\"RALEIGH\",\n \"state\":\"NC\",\n \"thinqTier\":0,\n \"match\":\"exact\"\n },\n { \n \"carrierName\":\"thinQ\",\n \"didSummary\":null,\n \"id\":19193008001,\n \"npanxx\":\"919300\",\n \"ratecenter\":\"RALEIGH\",\n \"state\":\"NC\",\n \"thinqTier\":0,\n \"match\":\"exact\"\n },\n { \n \"carrierName\":\"thinQ\",\n \"didSummary\":null,\n \"id\":19193008002,\n \"npanxx\":\"919300\",\n \"ratecenter\":\"RALEIGH\",\n \"state\":\"NC\",\n \"thinqTier\":0,\n \"match\":\"exact\"\n },\n { \n \"carrierName\":\"thinQ\",\n \"didSummary\":null,\n \"id\":19193008003,\n \"npanxx\":\"919300\",\n \"ratecenter\":\"RALEIGH\",\n \"state\":\"NC\",\n \"thinqTier\":0,\n \"match\":\"exact\"\n },\n { \n \"carrierName\":\"thinQ\",\n \"didSummary\":null,\n \"id\":19193008004,\n \"npanxx\":\"919300\",\n \"ratecenter\":\"RALEIGH\",\n \"state\":\"NC\",\n \"thinqTier\":0,\n \"match\":\"exact\"\n }\n ]\n}"}],"_postman_id":"b0d15399-62d1-42a3-a44d-ef8a3a20b204"},{"name":"Search With or Without Related Numbers","id":"c4d939fd-7a84-4694-8a69-3d509a9846c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.thinq.com/inbound/get-numbers?searchType=domestic&searchBy=npa&quantity=1&contiguous=false&related=true&npa=309&onNetOnly=false","description":"

Use the optional related parameter to include or not include related phone numbers in your search. If the parameter is absent or set to related=true, your search will include related phone number matches if there are no exact matches available or if there are not enough exact matches to meet the specified quantity. If the parameter is set to related=false, your search will not include related phone number matches.

You can search up to 100 numbers by changing the value of the quantity parameter

\n","urlObject":{"path":["inbound","get-numbers"],"host":["https://api.thinq.com"],"query":[{"key":"searchType","value":"domestic"},{"key":"searchBy","value":"npa"},{"key":"quantity","value":"1"},{"key":"contiguous","value":"false"},{"description":{"content":"

Optional, defaults to true

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

Optional, defaults to false

\n","type":"text/plain"},"key":"onNetOnly","value":"false"}],"variable":[]}},"response":[{"id":"54401755-f48e-4fd1-a377-1061cd0a6d60","name":"Search Exact/Related Numbers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.thinq.com/inbound/get-numbers?searchType=domestic&searchBy=npa&quantity=1&contiguous=false&related=true&npa=309&onNetOnly=false","host":["https://api.thinq.com"],"path":["inbound","get-numbers"],"query":[{"key":"searchType","value":"domestic"},{"key":"searchBy","value":"npa"},{"key":"quantity","value":"1"},{"key":"contiguous","value":"false"},{"key":"related","value":"true","description":"Optional, defaults to true"},{"key":"npa","value":"309"},{"key":"onNetOnly","value":"false","description":"Optional, defaults to false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"resultSet\": \"domestic\",\n \"exactDidsAmount\": 0,\n \"dids\": [\n {\n \"carrierName\": \"thinQ\",\n \"didSummary\": null,\n \"id\": 12175703322,\n \"npanxx\": \"217570\",\n \"ratecenter\": \"CLINTON\",\n \"state\": \"IL\",\n \"thinqTier\": 0,\n \"match\": \"related\"\n }\n ]\n}"},{"id":"b062dccb-25a1-4f07-b02c-6a165c366794","name":"Search Exact/Related Numbers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.thinq.com/inbound/get-numbers?searchType=domestic&searchBy=npa&quantity=1&contiguous=false&related=false&npa=309&onNetOnly=false","host":["https://api.thinq.com"],"path":["inbound","get-numbers"],"query":[{"key":"searchType","value":"domestic"},{"key":"searchBy","value":"npa"},{"key":"quantity","value":"1"},{"key":"contiguous","value":"false"},{"key":"related","value":"false","description":"Optional, defaults to true"},{"key":"npa","value":"309"},{"key":"onNetOnly","value":"false","description":"Optional, defaults to false"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"resultSet\": \"domestic\",\n \"exactDidsAmount\": 0,\n \"dids\": []\n}"}],"_postman_id":"c4d939fd-7a84-4694-8a69-3d509a9846c7"},{"name":"Retrieve Existing DIDs","event":[{"listen":"test","script":{"id":"151b6512-296a-4e54-924c-c3185a06cfac","type":"text/javascript","exec":["pm.test(\"Successful request\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201,202]);","});","","","pm.test(\"Response time is less than 100ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(response_time);","});"]}}],"id":"bb516a1f-c721-4e92-bbc6-03fbb6d8573a","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/origination/did/search2/did/{{account_id}}?rows=1&page=1","description":"

Use this to get all the DIDs associated with your account, along with configuration details. Numbers will contain foreign keys for caller id, location id, routing profile, sms profile, etc.

\n","urlObject":{"path":["origination","did","search2","did","{{account_id}}"],"host":["https://api.thinq.com"],"query":[{"key":"rows","value":"1"},{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"d8b408bd-5086-4511-a383-55ef5d035363","name":"Retrieve Existing DIDs copy","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"url":{"raw":"https://api.thinq.com/origination/did/search2/did/{{account_id}}?rows=1&page=1","host":["https://api.thinq.com"],"path":["origination","did","search2","did","{{account_id}}"],"query":[{"key":"rows","value":"1"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total_rows\": 291,\n \"has_next_page\": true,\n \"page\": 1,\n \"rows_per_page\": 1,\n \"rows\": [\n {\n \"lerg\": {\n \"lata\": \"XXX\",\n \"ocn\": \"XXXX\",\n \"company\": \"XXXX\",\n \"state\": \"XX\",\n \"ratecenter\": \"XXXXXX\"\n },\n \"carrier_id\": XX,\n \"carrier_name\": \"XXXXXX\",\n \"account_id\": \"XX\",\n \"caller_id\": XX,\n \"account_location_id\": XX,\n \"block_id\": null,\n \"route_id\": XX,\n \"didSummary\": \"(XXX) XXX-XXXX\",\n \"thinq_tier\": X,\n \"orders_ids\": [\n {\n \"id\": XXXX,\n \"type\": \"port-in_order\"\n },\n {\n \"id\": XXXX,\n \"type\": \"feature_order\"\n },\n {\n \"id\": XXXX,\n \"type\": \"feature_order\"\n }\n ],\n \"id\": XXXXXXXXXX,\n \"type\": \"did\"\n }\n ]\n}"}],"_postman_id":"bb516a1f-c721-4e92-bbc6-03fbb6d8573a"},{"name":"Retrieve a single Existing DID","event":[{"listen":"test","script":{"id":"151b6512-296a-4e54-924c-c3185a06cfac","exec":[""],"type":"text/javascript"}}],"id":"962d19b3-30b4-4b56-970c-a3a20018a718","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/origination/did/search2/did/{{account_id}}?add_summaries=true&id={{did}}&page=1&rows=25&sort=id:desc","description":"

Use this to get a particular number associated with your account, along with configuration details. Numbers will contain foreign keys for caller id, location id, routing profile, sms profile, etc.

\n","urlObject":{"path":["origination","did","search2","did","{{account_id}}"],"host":["https://api.thinq.com"],"query":[{"key":"add_summaries","value":"true"},{"key":"id","value":"{{did}}"},{"key":"page","value":"1"},{"key":"rows","value":"25"},{"key":"sort","value":"id:desc"}],"variable":[]}},"response":[{"id":"54d6de16-3614-454f-995b-76a53ad51540","name":"Retrieve a single Existing DID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"url":{"raw":"https://api.thinq.com/origination/did/search2/did/{{account_id}}?add_summaries=true&id=9789661184&page=1&rows=25&sort=id:desc","host":["https://api.thinq.com"],"path":["origination","did","search2","did","{{account_id}}"],"query":[{"key":"add_summaries","value":"true"},{"key":"id","value":"9789661184"},{"key":"page","value":"1"},{"key":"rows","value":"25"},{"key":"sort","value":"id:desc"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"total_rows\": 1,\n \"has_next_page\": false,\n \"page\": 1,\n \"rows_per_page\": 25,\n \"rows\": [\n {\n \"account_id\": {{account_id}},\n \"account_location_id\": null,\n \"callerIdSummary\": \"test test\",\n \"caller_id\": 3290,\n \"carrier_id\": 0,\n \"carrier_name\": \"thinQ\",\n \"carrier_tier\": 0,\n \"didSummary\": \"(978) 966-1184\",\n \"external\": null,\n \"features\": {\n \"cnam\": true,\n \"e911\": false,\n \"sms\": false\n },\n \"foc_date\": null,\n \"id\": 19789661184,\n \"lerg\": {\n \"company\": \"ONVOY\",\n \"lata\": \"128\",\n \"ocn\": \"892D\",\n \"ratecenter\": \"DANVERS\",\n \"state\": \"MA\"\n },\n \"note\": null,\n \"npanxx\": \"978966\",\n \"orders_ids\": [\n {\n \"id\": 36919,\n \"type\": \"feature_order\"\n }\n ],\n \"ported\": null,\n \"portin_zendesk_ticket\": null,\n \"provisioned\": false,\n \"route_id\": 0,\n \"sms_routing_profile_id\": null,\n \"tag\": \"test tag\",\n \"tf_lcr_profile_id\": null,\n \"tf_lcr_ready\": false,\n \"thinq_tier\": 0,\n \"tollfree_prefix\": null,\n \"type\": \"did\",\n \"status\": \"not_provisioned\"\n }\n ]\n}"}],"_postman_id":"962d19b3-30b4-4b56-970c-a3a20018a718"},{"name":"Download Existing DIDs","event":[{"listen":"test","script":{"id":"43cb571e-0884-45d1-aa37-e54efb213499","exec":["pm.test(\"Successful request\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201,202]);","});","","","pm.test(\"Response time is less than 100ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(response_time);","});"],"type":"text/javascript"}}],"id":"8642f0d6-5cae-4435-81d3-22cba2c28183","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"description":"

Your authentication string is a base64 encoded version of username:token

\n","key":"Authorization","value":"Basic {{auth_string}}"}],"url":"https://api.thinq.com/origination/did/download/{{account_id}}","description":"

Details - This request creates a download file with the existing DIDs. Once you retrieve the filename, add to the endpoint to actually download the file: @uri /origination/did/download/:account_id/:file_name

\n","urlObject":{"path":["origination","did","download","{{account_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8642f0d6-5cae-4435-81d3-22cba2c28183"},{"name":"Retrieve DID Tag","event":[{"listen":"test","script":{"id":"9727044f-fbc0-4a9d-9dc0-beadbdeb896b","type":"text/javascript","exec":[""]}}],"id":"09649f66-da23-482b-9196-320ef5d61a1c","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/account/{{account_id}}/origination/did/tag/{{did_id}}","description":"

Use this to return the existing tag associated with a DID.

\n","urlObject":{"path":["account","{{account_id}}","origination","did","tag","{{did_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"27bc75f5-1c59-49a9-8be1-913df713bb1e","name":"Retrieve DID Tag","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"url":"https://api.thinq.com/account/{{account_id}}/origination/did/tag/{{did_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"did_tag\": \"Sample Tag\"\n}"}],"_postman_id":"09649f66-da23-482b-9196-320ef5d61a1c"},{"name":"Retrieve Rate Centers","id":"72bb5c9e-8df2-4b53-9df4-934e111cf91e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.thinq.com/lerg/state/{{state}}","description":"

Retrieve the most updated list of rate centers we’re offering numbers from.

\n","urlObject":{"path":["lerg","state","{{state}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"b89a0d35-7c46-4086-bb85-bd2a9b1b68db","name":"Retrieve Rate Centers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"url":"https://api.thinq.com/lerg/state/{{state}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"total_rows\": 381,\n \"has_next_page\": false,\n \"page\": 1,\n \"rows_per_page\": 381,\n \"rows\": [\n \"ALLISON\",\n \"ALMA\",\n \"ALMYRA\",\n \"ALPENA\",\n \"ALTHEIMER\",\n \"ALTUS\",\n \"AMITY\",\n \"ARKADLPHIA\",\n \"ARKANSASCY\",\n \"ASH FLAT\",\n \"ASHDOWN\",\n \"ATKINS\",\n \"AUGUSTA\",\n \"AURORA\",\n \"BALD KNOB\",\n \"BANKS\",\n \"BATESVILLE\",\n \"BAUXITE\",\n \"BAY\",\n \"BEARDEN\",\n \"BEEBE\",\n \"BELLEVILLE\",\n \"BENTON\",\n \"BENTONVL\",\n \"BERRYVILLE\",\n \"BIGELOW\",\n \"BIGGERS\",\n \"BISMARCK\",\n \"BLACK ROCK\",\n \"BLACKFIHLK\",\n \"BLEVINS\",\n \"BLOOMNGGRV\",\n \"BLUE MT\",\n \"BLUFFTON\",\n \"BLYTHEVL\",\n \"BODCAW\",\n \"BOLES\",\n \"BOONEVILLE\",\n \"BRADFORD\",\n \"BRADLEY\",\n \"BRINKLEY\",\n \"BRYANTCGVL\",\n \"BULLSHOALS\",\n \"CABOT\",\n \"CALICOROCK\",\n \"CALION\",\n \"CAMDEN\",\n \"CARAWAY\",\n \"CARLISLE\",\n \"CARRYVILLE\",\n \"CARTHAGE\",\n \"CASA\",\n \"CASH\",\n \"CAVE CITY\",\n \"CENTER RDG\",\n \"CENTERTON\",\n \"CENTERVL\",\n \"CHARLESTON\",\n \"CHEROKEVLG\",\n \"CHERRY VLY\",\n \"CHIDESTER\",\n \"CLARENDON\",\n \"CLARKSVL\",\n \"CLEVELAND\",\n \"CLINTON\",\n \"COMPTON\",\n \"CONCORD\",\n \"CONWAY\",\n \"CORNING\",\n \"COTTONPLNT\",\n \"COVE\",\n \"COY\",\n \"CRAWFODSVL\",\n \"CROSSETT\",\n \"CRYSTALSPG\",\n \"DAISY\",\n \"DALARK\",\n \"DAMASCUS\",\n \"DANVILLE\",\n \"DARDANELLE\",\n \"DE QUEEN\",\n \"DE WITT\",\n \"DECATUR\",\n \"DEER\",\n \"DELAPLAINE\",\n \"DELIGHT\",\n \"DELL\",\n \"DERMOTT\",\n \"DES ARC\",\n \"DEVALLSBLF\",\n \"DIAMOND CY\",\n \"DIERKS\",\n \"DIR ASST\",\n \"DODGE CITY\",\n \"DONALDSON\",\n \"DOVER\",\n \"DRAKES CRK\",\n \"DUMAS\",\n \"DYESS\",\n \"EARLE\",\n \"EL DORADO\",\n \"ELAINE\",\n \"ELKINS\",\n \"ELMSPRINGS\",\n \"EMERSON\",\n \"ENGLAND\",\n \"ENOLA\",\n \"EUDORA\",\n \"EUREKA SPG\",\n \"EVENNGSHAD\",\n \"FAIRFLD BY\",\n \"FARMINGTON\",\n \"FAYETTEVL\",\n \"FERNDALE\",\n \"FIFTYSIX\",\n \"FISHER\",\n \"FLIPPIN\",\n \"FORDYCE\",\n \"FOREMAN\",\n \"FORREST CY\",\n \"FORT SMITH\",\n \"FORUM\",\n \"FOUKE\",\n \"FOX\",\n \"FRANKLIN\",\n \"FULTON\",\n \"GAMALIEL\",\n \"GARDEN PT\",\n \"GARFIELD\",\n \"GASSVILLE\",\n \"GATEWAY\",\n \"GENTRY\",\n \"GILLETT\",\n \"GILLHAM\",\n \"GLENWOOD\",\n \"GOULD\",\n \"GRADY\",\n \"GRAVETTE\",\n \"GREEN FOR\",\n \"GREENBRIER\",\n \"GREENWOOD\",\n \"GREERSFRRY\",\n \"GRIFFITHVL\",\n \"GRUBBS\",\n \"GURDON\",\n \"HACKETT\",\n \"HAMBURG\",\n \"HAMPTON\",\n \"HARDY\",\n \"HARRISBURG\",\n \"HARRISON\",\n \"HARTMAN\",\n \"HATFIELD\",\n \"HAVANA\",\n \"HAZEN\",\n \"HEBER SPG\",\n \"HECTOR\",\n \"HELENA\",\n \"HENDERSON\",\n \"HERMITAGE\",\n \"HICKORY PL\",\n \"HICKORYRDG\",\n \"HINDSVILLE\",\n \"HOLLYGROVE\",\n \"HOPE\",\n \"HORATIO\",\n \"HORSEHBEND\",\n \"HOTSPRINGS\",\n \"HUGHES\",\n \"HUMPHREY\",\n \"HUNTSVILLE\",\n \"HUTTIG\",\n \"IMBODEN\",\n \"JACKSONVL\",\n \"JASPER\",\n \"JESSIEVL\",\n \"JESUP\",\n \"JOINER\",\n \"JONESBORO\",\n \"JONESMILLS\",\n \"JUDSONIA\",\n \"JUNCTIONCY\",\n \"KEISER\",\n \"KENSETT\",\n \"KINGSLAND\",\n \"KINGSTON\",\n \"KNOBEL\",\n \"LAKE CITY\",\n \"LAKE VLG\",\n \"LAKEHINKLE\",\n \"LAKEVIEW\",\n \"LAMAR\",\n \"LAVACA\",\n \"LEACHVILLE\",\n \"LEAD HILL\",\n \"LEOLA\",\n \"LEONARD\",\n \"LEPANTO\",\n \"LESLIE\",\n \"LEWISVILLE\",\n \"LINCOLN\",\n \"LITTLEROCK\",\n \"LOCKESBURG\",\n \"LONDON\",\n \"LONOKE\",\n \"LONSDALE\",\n \"LOUANN\",\n \"LURTON\",\n \"LUXORA\",\n \"MACEDONIA\",\n \"MAGAZINE\",\n \"MAGNOLIA\",\n \"MALLARD PT\",\n \"MALVERN\",\n \"MAMMOTHSPG\",\n \"MANILA\",\n \"MANSFIELD\",\n \"MARIANNA\",\n \"MARION\",\n \"MARKEDTREE\",\n \"MARMADUKE\",\n \"MARSHALL\",\n \"MARVELL\",\n \"MAUMELLE\",\n \"MAYNARD\",\n \"MAYSVILLE\",\n \"MCCRORY\",\n \"MCGEHEE\",\n \"MCNEIL\",\n \"MCRAE\",\n \"MELBOURNE\",\n \"MENA\",\n \"MIDLAND\",\n \"MIDWAY\",\n \"MINERALSPG\",\n \"MONETTE\",\n \"MONTICELLO\",\n \"MORGANTON\",\n \"MORO\",\n \"MORRILTON\",\n \"MORROW\",\n \"MOUNT IDA\",\n \"MOUNTAINBG\",\n \"MOUNTHOLLY\",\n \"MOUNTJUDEA\",\n \"MT HOME\",\n \"MT VIEW\",\n \"MTPLEASANT\",\n \"MULBERRY\",\n \"MURFREESBO\",\n \"NASHVILLE\",\n \"NATURALDAM\",\n \"NEWARK\",\n \"NEWPORT\",\n \"NIMROD\",\n \"NORFORK\",\n \"NORMAN\",\n \"NORPHLET\",\n \"NOSPRINGHL\",\n \"OAK ACRES\",\n \"OAK GROVE\",\n \"ODEN\",\n \"OIL TROUGH\",\n \"OKOLONA\",\n \"OLA\",\n \"OMAHA\",\n \"OSAGE\",\n \"OSCEOLA\",\n \"OXFORD\",\n \"OZARK\",\n \"OZARKACRES\",\n \"PALARM\",\n \"PANGBURN\",\n \"PARAGOULD\",\n \"PARIS\",\n \"PARKIN\",\n \"PARON\",\n \"PAYNEWAY\",\n \"PEA RIDGE\",\n \"PERRY\",\n \"PERRYVILLE\",\n \"PIGGOTT\",\n \"PINE BLUFF\",\n \"PINNACLE\",\n \"PLAINVIEW\",\n \"PLEASANTPL\",\n \"PLEASATGRV\",\n \"POCAHONTAS\",\n \"POLLARD\",\n \"PONCA\",\n \"PORTLAND\",\n \"PRAIRIEGRV\",\n \"PRATTSVL\",\n \"PRESCOTT\",\n \"PRIM\",\n \"PYATT\",\n \"QUITMAN\",\n \"RATCLIFF\",\n \"RECTOR\",\n \"REDFIELD\",\n \"RISON\",\n \"ROE\",\n \"ROGERS\",\n \"ROSE BUD\",\n \"ROSSTON\",\n \"ROWELL\",\n \"RUDD\",\n \"RUSSELLVL\",\n \"SALEM\",\n \"SALUS\",\n \"SARATOGA\",\n \"SCOTLAND\",\n \"SCOTT\",\n \"SCRANTON\",\n \"SEARCY\",\n \"SHERIDAN\",\n \"SHIRLEY\",\n \"SILOAM SPG\",\n \"SMACKOVER\",\n \"SO FOURCHE\",\n \"SO MYRTLE\",\n \"SOWESTCITY\",\n \"SPARKMAN\",\n \"SPRINGDALE\",\n \"SPRINGLAKE\",\n \"ST CHARLES\",\n \"ST JOE\",\n \"ST PAUL\",\n \"STAMPS\",\n \"STAR CITY\",\n \"STEPHENS\",\n \"STRICKLER\",\n \"STRONG\",\n \"STUTTGART\",\n \"SUBIACO\",\n \"SUCCESS\",\n \"SULPHURSPG\",\n \"SUNNYLAND\",\n \"SWIFTON\",\n \"SYVNHLSHWD\",\n \"TAYLOR\",\n \"TEXARKANA\",\n \"TILLAR\",\n \"TIMBO\",\n \"TRACYFERRY\",\n \"TRIGG\",\n \"TRUMANN\",\n \"TUCKERMAN\",\n \"TUPELO\",\n \"TURRELL\",\n \"TYRONZA\",\n \"UMPIRE\",\n \"URBANA\",\n \"VAN BUREN\",\n \"VILLAGE\",\n \"VILONIA\",\n \"VIOLA\",\n \"W MEMPHIS\",\n \"WALDENBURG\",\n \"WALDO\",\n \"WALDRON\",\n \"WALNUT RDG\",\n \"WARREN\",\n \"WASHINGTON\",\n \"WATSON\",\n \"WEINER\",\n \"WEST FORK\",\n \"WESTERNGRV\",\n \"WHEATLEY\",\n \"WHITEVILLE\",\n \"WICKES\",\n \"WILMAR\",\n \"WILMOT\",\n \"WILSON\",\n \"WINSLOW\",\n \"WINTHROP\",\n \"WITTS SPG\",\n \"WRIGHTSVL\",\n \"WYE\",\n \"WYNNE\",\n \"YELLVILLE\"\n ]\n}"}],"_postman_id":"72bb5c9e-8df2-4b53-9df4-934e111cf91e"},{"name":"Delete Existing DID Tag","event":[{"listen":"test","script":{"id":"42801e94-9904-413c-94d2-f67d83b6d0f5","type":"text/javascript","exec":[""]}}],"id":"714f3e76-d7f3-495f-adb1-bab237980e48","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/tag/{{did_id}}","description":"

Delete an existing DID tag

\n","urlObject":{"path":["account","{{account_id}}","origination","did","tag","{{did_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"b217ef12-e368-49cf-ae10-85302cbfc7e1","name":"Delete Existing DID Tag","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/tag/{{did_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"200 http code"}],"_postman_id":"714f3e76-d7f3-495f-adb1-bab237980e48"},{"name":"Set/Update DID Tag","event":[{"listen":"test","script":{"id":"f405103c-d6d5-4759-951f-73430adbcdb8","type":"text/javascript","exec":[""]}}],"id":"1b77ff1a-1237-44ea-8526-98d76b6949a1","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":"{\n \"tag\": \"Sample Tag\"\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/tag/{{did_id}}","description":"

Set or update the tag value for a DID.

\nThese resources let you interact with DIDs and their availability. You can:\n

Search for individual numbers to purchase
Search for DID blocks to purchase
Search for available toll free numbers
Retrieve a list of your own DIDs
Maintain tags on your DIDs

\n\n

","event":[{"listen":"prerequest","script":{"id":"6e7cbb9a-fef0-423b-bb63-8150c3350e10","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"985c26d1-1d10-4685-9452-471038d8de7a","type":"text/javascript","exec":[""]}}],"_postman_id":"55e22ebf-e83f-4db1-a111-2f4715613d26","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Ordering","item":[{"name":"Purchase Individual Numbers","event":[{"listen":"test","script":{"id":"3919411c-e53b-4092-be78-3fefb8ff92f2","type":"text/javascript","exec":["",""]}},{"listen":"prerequest","script":{"id":"3ce2f266-3b93-4ca9-981c-b4623e161541","type":"text/javascript","exec":["","","","","","","",""]}}],"id":"1a26a37b-cb7d-4931-ab05-5b5af56339da","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"tns\": [\n\t\t{\n\t\t\t\"caller_id\": null,\n\t\t\t\"account_location_id\": null,\n\t\t\t\"sms_routing_profile_id\": null,\n\t\t\t\"route_id\": null,\n\t\t\t\"features\": {\n\t\t\t \"cnam\": false,\n\t\t\t \"sms\": true,\n\t\t\t \"e911\": false\n\t\t\t},\n\t\t\t\"did\": XXXXXXXXXX\n\t\t}\n ],\n \"blocks\": []\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/order/create","description":"

Use this to purchase DIDs returned from one of the number searches.

Be advised this is a two-step process. Your order is not finished after the first step.
\nThis is so you can make alterations to the configuration before proceeding.

\n\n

In order to finalize your purchase you must execute the \"Complete Order\" process.

\nThe payload should be an array of DIDs with configuration details. Boolean values allow enabling of e911, outbound caller ID, and SMS support. Foreign keys are used to assign the lookup values. You can retrieve or configure new lookup values at the associated endpoints.\n

CNAM Out Profiles
e911 Sites
Inbound Routing Profiles
SMS Routing Profiles

","urlObject":{"path":["account","{{account_id}}","origination","order","create"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"f4758f02-e589-4df4-8e43-ecdc8a308f64","name":"Purchase Individual Numbers","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"tns\": [\n\t\t{\n\t\t\t\"caller_id\": null,\n\t\t\t\"account_location_id\": null,\n\t\t\t\"sms_routing_profile_id\": null,\n\t\t\t\"route_id\": null,\n\t\t\t\"features\": {\n\t\t\t \"cnam\": false,\n\t\t\t \"sms\": true,\n\t\t\t \"e911\": false\n\t\t\t},\n\t\t\t\"did\": XXXXXXXXXX\n\t\t}\n ],\n \"blocks\": []\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/order/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"account_id\": \"XX\",\n \"user_id\": \"username\",\n \"status\": \"created\",\n \"tns\": [\n {\n \"did\": XXXXXXXXXX\n }\n ],\n \"blocks\": [],\n \"sessions\": 0,\n \"created\": 1508423134,\n \"completed\": null,\n \"invoice_id\": null,\n \"invoice_url\": null,\n \"sub_type\": \"did_order\",\n \"appliedChangeLog\": null,\n \"taxExemption\": null,\n \"id\": XXXX,\n \"type\": \"origination_order\"\n}\n"}],"_postman_id":"1a26a37b-cb7d-4931-ab05-5b5af56339da"},{"name":"Purchase DID Blocks","event":[{"listen":"test","script":{"id":"7ff51537-4a0d-4702-bd64-1a305a423438","type":"text/javascript","exec":["","","",""]}}],"id":"57862de7-0856-4968-b4da-345093a8a551","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"tns\": [],\n \"blocks\": [\n {\n \"range\": {\n \"from\": 3302497277,\n \"to\": 3302497296\n }\n }\n ]\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/order/create","description":"

Use this to purchase a block of sequential DIDs. Available ranges can be found by using the DID block search.

Be advised this is a two-step process. Your order is not finished after the first step.
\nThis is so you can make alterations to the configuration before proceeding.

\n\n

In order to finalize your purchase you must execute the \"Complete Order\" process.

","urlObject":{"path":["account","{{account_id}}","origination","order","create"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"76232a8e-23cf-42ed-b1a0-52b886d8b0e3","name":"Purchase DID Blocks","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"tns\": [],\n \"blocks\": [\n {\n \"range\": {\n \"from\": 3302497277,\n \"to\": 3302497296\n }\n }\n ]\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/order/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"account_id\": \"XXX\",\n \"user_id\": \"XXX\",\n \"status\": \"created\",\n \"tns\": [],\n \"blocks\": [\n {\n \"carrier_id\": 75,\n \"carrier_name\": \"Inteliquent\",\n \"account_id\": null,\n \"range\": {\n \"from\": XXXXXXXXXX,\n \"to\": XXXXXXXXXX\n },\n\n \"id\": XXX,\n \"type\": \"did_block\",\n \"blockSummary\": \"(XXX) XXX-XX[XX-XX]\",\n \"quantity\": 10,\n \"monthly\": 1,\n \"oneTime\": 1,\n \"price\": 1,\n \"carrier_cost\": null,\n \"account_location_id\": null,\n \"block_id\": XXX\n }\n ],\n \"sessions\": 0,\n \"created\": 1508959293,\n \"completed\": null,\n \"invoice_id\": null,\n \"invoice_url\": null,\n \"sub_type\": \"did_order\",\n \"appliedChangeLog\": null,\n \"taxExemption\": false,\n \"id\": \"XXXX\",\n \"type\": \"origination_order\"\n}"}],"_postman_id":"57862de7-0856-4968-b4da-345093a8a551"},{"name":"Update Order","event":[{"listen":"test","script":{"id":"3919411c-e53b-4092-be78-3fefb8ff92f2","exec":["",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"3ce2f266-3b93-4ca9-981c-b4623e161541","exec":["","","","","","","",""],"type":"text/javascript"}}],"id":"e1d1a358-91eb-4975-a2b2-ec8ef9557a32","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"id\": 987654,\n \"tns\": [\n\t\t{\n\t\t\t\"caller_id\": null,\n\t\t\t\"account_location_id\": null,\n\t\t\t\"sms_routing_profile_id\": null,\n\t\t\t\"route_id\": null,\n\t\t\t\"features\": {\n\t\t\t \"cnam\": false,\n\t\t\t \"sms\": true,\n\t\t\t \"e911\": false\n\t\t\t},\n\t\t\t\"did\": XXXXXXXXXX\n\t\t}\n ],\n \"blocks\": [],\n \"group_id\": 123\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/order/create","description":"

Use this to update a DID order you have previously created.

This is so you can make alterations to the configuration before proceeding, such as enabling SMS, or assigning a Group ID to this order.

\n\n

In order to finalize your purchase you must execute the \"Complete Order\" process.

\n\n

The payload should be an array of DIDs with configuration details. Boolean values allow enabling of e911, outbound caller ID, and SMS support. Foreign keys are used to assign the lookup values. You can retrieve or configure new lookup values at the associated endpoints.

\n\n

CNAM Out Profiles
e911 Sites
Inbound Routing Profiles
SMS Routing Profiles
Group ID

","urlObject":{"path":["account","{{account_id}}","origination","order","create"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"9d339fac-4789-4afe-b717-0424e8de74df","name":"Update Order","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"tns\": [\n\t\t{\n\t\t\t\"caller_id\": null,\n\t\t\t\"account_location_id\": null,\n\t\t\t\"sms_routing_profile_id\": null,\n\t\t\t\"route_id\": null,\n\t\t\t\"features\": {\n\t\t\t \"cnam\": false,\n\t\t\t \"sms\": true,\n\t\t\t \"e911\": false\n\t\t\t},\n\t\t\t\"did\": XXXXXXXXXX\n\t\t}\n ],\n \"blocks\": []\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/order/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"account_id\": \"XX\",\n \"user_id\": \"username\",\n \"status\": \"created\",\n \"tns\": [\n {\n \"did\": XXXXXXXXXX\n }\n ],\n \"blocks\": [],\n \"sessions\": 0,\n \"created\": 1508423134,\n \"completed\": null,\n \"invoice_id\": null,\n \"invoice_url\": null,\n \"sub_type\": \"did_order\",\n \"appliedChangeLog\": null,\n \"taxExemption\": null,\n \"id\": XXXX,\n \"type\": \"origination_order\"\n}\n"}],"_postman_id":"e1d1a358-91eb-4975-a2b2-ec8ef9557a32"},{"name":"Complete Order","event":[{"listen":"test","script":{"id":"cce4e04f-a206-4bd7-8c74-4be3c59fd9c1","type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = pm.response.json();"," console.log(jsonData);","pm.test(\"Completed order did is set\", function () {"," pm.environment.set(\"did_for_features\", jsonData.tns[0].did);","});","",""]}}],"id":"3b57ccd7-685c-41d0-94d1-d41b3aad5589","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/origination/order/complete/{{order_id}}","description":"

\n Use this to complete an existing order created using one of the following resources:\n

Purchase Individual Numbers
Purchase DID Blocks

Use this to retrieve the status of an existing order created using one of the following resources:

Purchase Individual Numbers
Purchase DID Blocks

","urlObject":{"path":["account","{{account_id}}","origination","order","{{order_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"a4b79c76-26cf-49b4-9674-25ed5190a949","name":"Retrieve Order","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"url":"https://api.thinq.com/account/{{account_id}}/origination/order/{{order_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"account_id\": \"XXX\",\n \"user_id\": \"XXXX\",\n \"status\": \"created\",\n \"tns\": [\n {\n \"did\": XXXXXXXXXX\n }\n ],\n \"blocks\": null,\n \"sessions\": 0,\n \"created\": 1508423134,\n \"completed\": null,\n \"invoice_id\": null,\n \"invoice_url\": null,\n \"sub_type\": \"did_order\",\n \"id\": XXXX,\n \"type\": \"origination_order\",\n \"portin_process_id\": null\n}"}],"_postman_id":"e7be5bc7-127f-4a7f-b14c-348e354faf6e"},{"name":"Cancel Order","event":[{"listen":"test","script":{"exec":["pm.test(\"Successful request\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201,202]);","});"],"id":"64038e24-1e0c-494f-a380-d6ba6fa42396","type":"text/javascript"}}],"id":"d0a1a710-6a8b-4558-a1ce-81ec6cfa7833","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/origination/order/cancel/{{order_id}}","description":"

Use this to cancel an in-flight order created using one of the following resources:

Purchase Individual Numbers
Purchase DID Blocks

","urlObject":{"path":["account","{{account_id}}","origination","order","cancel","{{order_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"0cf03ec4-62bf-457e-a408-0668e76d355f","name":"Cancel Order","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/origination/order/cancel/{{order_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"account_id\": \"XXX\",\n \"user_id\": \"XXXX\",\n \"status\": \"canceled\",\n \"tns\": [\n {\n \"did\": XXXXXXXXXX\n }\n ],\n \"blocks\": null,\n \"created\": 1509563749,\n \"invoice_id\": null,\n \"invoice_url\": null,\n \"sub_type\": \"did_order\",\n \"id\": XXXX,\n}"}],"_postman_id":"d0a1a710-6a8b-4558-a1ce-81ec6cfa7833"},{"name":"Retrieve Order Price","event":[{"listen":"test","script":{"id":"490a7397-515d-4d36-89e1-686d8e987306","type":"text/javascript","exec":["pm.test(\"Successful request\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201,202]);","});","","","pm.test(\"Status code is 2++\", function () {"," pm.response.to.be.oneOf([200,201,202]);","});"]}}],"id":"96145989-05ff-4eee-a591-f77f978f6d5a","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/account/{{account_id}}/origination/order/complete/{{order_id}}","description":"

\n Use this to retrieve pricing details on orders created using:\n

Purchase Individual Numbers
Purchase DID Blocks

","urlObject":{"path":["account","{{account_id}}","origination","order","complete","{{order_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"794e946b-d260-4c3a-93b8-b40b4e4f8294","name":"Retrieve Order Price","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"url":"https://api.thinq.com/account/{{account_id}}/origination/order/complete/{{order_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"cost_by_tier\": 0.2,\n \"subtotal\": 0.2,\n \"taxes\": 0,\n \"total\": 0.2,\n \"summary\": {\n \"did_tiers\": [\n {\n \"tier_id\": 0,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 1,\n \"unit_rc_price\": 1,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n {\n \"tier_id\": 1,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 1,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0.1,\n \"unit_rc_price\": 0.2,\n \"one_time_price\": 0,\n \"monthly\": 0.2,\n \"rc_price\": 0.2,\n \"nrc_price\": 0,\n \"price\": 0.2,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"list\": [\n 9842298604\n ]\n },\n {\n \"tier_id\": 2,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0.1,\n \"unit_rc_price\": 0.25,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n {\n \"tier_id\": 3,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0.1,\n \"unit_rc_price\": 0.25,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n {\n \"tier_id\": 4,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 1,\n \"unit_rc_price\": 1,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n }\n ],\n \"tollfree\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 2,\n \"unit_rc_price\": 0.5,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"list\": []\n },\n \"porting_tiers\": [\n {\n \"portin_quantity\": 0,\n \"portin_unit_price\": 1,\n \"portin_tax_percentage\": null,\n \"portout_quantity\": 0,\n \"portout_unit_price\": 1,\n \"portout_tax_percentage\": null,\n \"tier_id\": 0,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"in_taxed_price\": 0,\n \"out_taxed_price\": 0\n },\n {\n \"portin_quantity\": 0,\n \"portin_unit_price\": 3,\n \"portin_tax_percentage\": null,\n \"portout_quantity\": 0,\n \"portout_unit_price\": 8,\n \"portout_tax_percentage\": null,\n \"tier_id\": 1,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"in_taxed_price\": 0,\n \"out_taxed_price\": 0\n },\n {\n \"portin_quantity\": 0,\n \"portin_unit_price\": 3,\n \"portin_tax_percentage\": null,\n \"portout_quantity\": 0,\n \"portout_unit_price\": 8,\n \"portout_tax_percentage\": null,\n \"tier_id\": 2,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"in_taxed_price\": 0,\n \"out_taxed_price\": 0\n },\n {\n \"portin_quantity\": 0,\n \"portin_unit_price\": 3,\n \"portin_tax_percentage\": null,\n \"portout_quantity\": 0,\n \"portout_unit_price\": 8,\n \"portout_tax_percentage\": null,\n \"tier_id\": 3,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"in_taxed_price\": 0,\n \"out_taxed_price\": 0\n },\n {\n \"portin_quantity\": 0,\n \"portin_unit_price\": 1,\n \"portin_tax_percentage\": null,\n \"portout_quantity\": 0,\n \"portout_unit_price\": 1,\n \"portout_tax_percentage\": null,\n \"tier_id\": 4,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"in_taxed_price\": 0,\n \"out_taxed_price\": 0\n }\n ],\n \"porting_tollfree\": {\n \"portin_quantity\": 0,\n \"portin_unit_price\": 3,\n \"portin_tax_percentage\": null,\n \"portout_quantity\": 0,\n \"portout_unit_price\": 8,\n \"portout_tax_percentage\": null,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"in_taxed_price\": 0,\n \"out_taxed_price\": 0\n },\n \"cnam_in\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"cnam_out\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 10,\n \"unit_rc_price\": 5,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"credited\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"e911\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 100,\n \"unit_rc_price\": 10,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"sms\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 5,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"sessions\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"portin_cancel\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 175,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"snapback\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 300,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"disconnect_tiers\": [\n {\n \"disconnect_quantity\": 0,\n \"disconnect_unit_price\": 1,\n \"disconnect_tax_percentage\": 0,\n \"tier_id\": 0,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"disconnect_taxed_price\": 0\n },\n {\n \"disconnect_quantity\": 0,\n \"disconnect_unit_price\": 0.2,\n \"disconnect_tax_percentage\": 0,\n \"tier_id\": 1,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"disconnect_taxed_price\": 0\n },\n {\n \"disconnect_quantity\": 0,\n \"disconnect_unit_price\": 0.3,\n \"disconnect_tax_percentage\": 0,\n \"tier_id\": 2,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"disconnect_taxed_price\": 0\n },\n {\n \"disconnect_quantity\": 0,\n \"disconnect_unit_price\": 0.4,\n \"disconnect_tax_percentage\": 0,\n \"tier_id\": 3,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"disconnect_taxed_price\": 0\n },\n {\n \"disconnect_quantity\": 0,\n \"disconnect_unit_price\": 1,\n \"disconnect_tax_percentage\": 0,\n \"tier_id\": 4,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"disconnect_taxed_price\": 0\n }\n ],\n \"disconnect_tollfree\": {\n \"disconnect_quantity\": 0,\n \"disconnect_unit_price\": 0.6,\n \"disconnect_tax_percentage\": 0,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"disconnect_taxed_price\": 0\n },\n \"cnam_in_hits\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"discounts\": {\n \"porting_tiers\": []\n },\n \"usage_regular_mms_in\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_regular_mms_out\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_regular_sms_in\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_regular_sms_out\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_tollfree_mms_in\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_tollfree_mms_out\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_tollfree_sms_in\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_tollfree_sms_out\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"credited_amount\": 0,\n \"type\": \"order_summary\"\n }\n}"}],"_postman_id":"96145989-05ff-4eee-a591-f77f978f6d5a"},{"name":"Disconnect DIDs","event":[{"listen":"test","script":{"id":"ea41c54a-a782-477b-9e7e-0e9c70580218","type":"text/javascript","exec":["","","",""]}}],"id":"e90f4497-f1f9-4131-a50c-be1ac5432176","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":"{\n \"dids\": [\n XXXXXXXXXX\n ]\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/disconnect","description":"

Use this to disconnect an array of DIDs associated with your account.

\n","urlObject":{"path":["account","{{account_id}}","origination","disconnect"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"5b18b4ce-ab41-455a-b310-f815d9cd7e50","name":"Disconnect DIDs","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"url":"https://api.thinq.com/account/{{account_id}}/origination/disconnect"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"order\": {\n \"account_id\": \"XX\",\n \"user_id\": \"XXXX\",\n \"status\": \"completed\",\n \"tns\": [\n {\n \"did\": XXXXXXXXXX,\n }\n ],\n \"blocks\": [],\n \"sessions\": 0,\n \"created\": 1510085048,\n \"completed\": 1510085048,\n \"invoice_id\": null,\n \"invoice_url\": null,\n \"sub_type\": \"disconnect_order\",\n \"id\": XXXX,\n \"type\": \"origination_order\"\n }\n}"}],"_postman_id":"e90f4497-f1f9-4131-a50c-be1ac5432176"},{"name":"Create Feature Order","event":[{"listen":"test","script":{"id":"673fcdf3-24ed-4def-a19b-051216f9e750","type":"text/javascript","exec":["",""]}}],"id":"bd80b8b1-057c-47eb-be6f-b4ec8e5ddd89","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"tns\": [\n {\n \"caller_id\": null,\n \"account_location_id\": null,\n \"sms_routing_profile_id\": null,\n \"route_id\": null,\n \"features\": {\n \"cnam\": false,\n \"sms\": true,\n \"e911\": false\n },\n \"did\": 9193715690\n }\n ]\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/features/create","description":"

Feature Orders are the way you change configuration details for a DID.

Be advised this is a two-step process. Your order is not finished after the first step.
\nThis is so you can make alterations to the configuration before proceeding.

\n\n

In order to finalize your purchase you must execute the \"Complete Feature Order\" process.

\n This includes assigning new values for:\n

CNAM Out Profile
e911 Site
Inbound Routing Profile
SMS Routing Profile

\n \n

You can also enable/disable features like:\n<ul>\n<li>CNAM Out</li>\n<li>e911</li>\n<li>SMS Support</li>\n</ul>\n

","urlObject":{"path":["account","{{account_id}}","origination","did","features","create"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"61c7e0dd-97cf-46b4-9924-8ca9ab8f4149","name":"Create Feature Order","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"tns\": [\n {\n \"caller_id\": null,\n \"account_location_id\": null,\n \"sms_routing_profile_id\": null,\n \"features\": {\n \"cnam\": false,\n \"sms\": true,\n \"e911\": false\n },\n \"did\": 9193715690\n }\n ]\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/features/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"order\":{\n \"isBulkOrder\":false,\n \"account_id\":\"XX\",\n \"user_id\":\"XXXX\",\n \"status\":\"created\",\n \"tns\":[\n {\n \"did\":19193715690,\n \"features\":{\n \"cnam\":false,\n \"e911\":false,\n \"sms\":true\n },\n \"account_location_id\":null,\n \"caller_id\":null,\n \"sms_routing_profile_id\":3241\n }\n ],\n \"blocks\":[],\n \"created\":1651858017,\n \"completed\":null,\n \"invoice_id\":null,\n \"invoice_url\":null,\n \"sub_type\":\"feature_order\",\n \"taxExemption\":false,\n \"completion_started\":false,\n \"account_name\":null,\n \"billing_address\":null,\n \"payment_type\":null,\n \"payment_method\":null,\n \"user_created\":null,\n \"user_completed\":null,\n \"total\":null,\n \"subtotal\":null,\n \"taxes\":null,\n \"discount\":null,\n \"credited_amount\":null,\n \"summary\":null,\n \"id\":367375,\n \"type\":\"origination_order\"\n }\n}"}],"_postman_id":"bd80b8b1-057c-47eb-be6f-b4ec8e5ddd89"},{"name":"Update Feature Order","event":[{"listen":"test","script":{"id":"8c497f9a-bb2e-4170-88bc-75cbb1ca0fc4","type":"text/javascript","exec":[""]}}],"id":"98b47263-f4a0-497d-b975-e18abd7ef08b","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/account/{{account_id}}/origination/did/features/create/{{order_id}}","description":"

Use this to modify to status of a pending configuration change that was created by the Create Feature Order resource.

\n","urlObject":{"path":["account","{{account_id}}","origination","did","features","create","{{order_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"ec59f0cc-3245-457a-87f4-77d058af4e21","name":"Update Feature Order","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"url":"https://api.thinq.com/account/{{account_id}}/origination/did/features/create/{{order_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"order\": {\n \"account_id\": \"XXX\",\n \"user_id\": \"XXXX\",\n \"status\": \"created\",\n \"tns\": [\n {\n \"did\": XXXXXXXXXX,\n \"features\": {\n \"cnam\": true,\n \"sms\": true,\n \"e911\": false\n },\n \"account_location_id\": XXX,\n \"sms_routing_profile_id\": XXX,\n \"caller_id\": XXX\n }\n ],\n \"blocks\": [],\n \"sessions\": 0,\n \"created\": 1509473107,\n \"completed\": null,\n \"invoice_id\": null,\n \"invoice_url\": null,\n \"sub_type\": \"feature_order\",\n \"appliedChangeLog\": null,\n \"taxExemption\": false,\n \"id\": XXXX,\n \"type\": \"origination_order\",\n \"portin_process_id\": null\n }\n}"}],"_postman_id":"98b47263-f4a0-497d-b975-e18abd7ef08b"},{"name":"Complete Feature Order","event":[{"listen":"test","script":{"id":"cce4e04f-a206-4bd7-8c74-4be3c59fd9c1","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = pm.response.json();"," console.log(jsonData);","pm.test(\"Completed order did is set\", function () {"," pm.environment.set(\"did_for_features\", jsonData.tns[0].did);","});","",""],"type":"text/javascript"}}],"id":"d3946d1a-a61a-4f3a-964f-7d21e3bd5abc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"description":"

Your authentication string is a base64 encoded version of username:token

\n","key":"Authorization","value":"Basic {{auth_string}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/features/complete/{{order_id}}","description":"

Use this to complete an existing feature order created using the Create Feature Order resource.

\n \n \n

If you are enabling SMS on a number, SMS provisioning could take up to 15 minutes. Please wait at least 15 minutes before using the number or assigning the number to a campaign.

","urlObject":{"path":["account","{{account_id}}","origination","did","features","complete","{{order_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"535b4f6f-8169-48e0-a348-39592f2e68ff","name":"Complete Feature Order","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/origination/order/complete/{{order_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"order\": {\n \"account_id\": \"XX\",\n \"user_id\": \"XXXX\",\n \"status\": \"completed\",\n \"tns\": [\n {\n \"did\": NPANXXXXXX,\n \"features\": {\n \"cnam\": true,\n \"sms\": true,\n \"e911\": false\n },\n \"account_location_id\": XX,\n \"caller_id\": XXX,\n \"sms_routing_profile_id\": XX\n }\n ],\n \"blocks\": [],\n \"sessions\": 0,\n \"created\": 1514397269,\n \"completed\": 1514398935,\n \"invoice_id\": null,\n \"invoice_url\": null,\n \"sub_type\": \"feature_order\",\n \"appliedChangeLog\": [\n {\n \"did\": NPANXXXXXX,\n \"toRecord\": true,\n \"account_location_id_old\": XX,\n \"account_location_id_changed\": false,\n \"e911_changed\": true,\n \"e911\": false,\n \"account_location_id\": 98\n }\n ],\n \"taxExemption\": false,\n \"id\": XXXX,\n \"type\": \"origination_order\"\n }\n}"}],"_postman_id":"d3946d1a-a61a-4f3a-964f-7d21e3bd5abc"},{"name":"Retrieve Feature Order","event":[{"listen":"test","script":{"id":"3957e7bf-4f7e-4c15-b3cf-bf8049de389d","type":"text/javascript","exec":["","","",""]}}],"id":"94771055-6b43-4fc4-b31d-b48aee7749c8","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/features/create/{{order_id}}","description":"

This will allow you to retrieve the status of a configuration change that was created by the Create Feature Order resource.

DID ordering and maintenance

\n","event":[{"listen":"prerequest","script":{"id":"695c2f73-bee1-43e7-9cba-ed7fd04b62ca","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ccad7f4f-b763-44e1-832d-e9e49954fd52","type":"text/javascript","exec":[""]}}],"_postman_id":"1d958f2b-d8c4-452c-ba36-6ba97a8d7d2c","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Port In Process","item":[{"name":"Upload DIDs to Check Port In Availability","id":"28c563d2-e13d-41a0-9d2d-39ff08f06fa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Basic {{auth_string}}"}],"body":{"mode":"raw","raw":"{\n \"dids\": { \"type\": \"array\", \"items\": { \"type\": \"string\" }, \"example\": [\"9198002000\"]}\n}"},"url":"https://api.thinq.com/inbound/port-in/upload/text","description":"

Body (post request body as application/json)

\"properties\": {\n    \"dids\": { \"type\": \"array\", \"items\": { \"type\": \"string\" }, \"example\": [\"9198002000\"] }\n},\n

EXAMPLE (in body of request):

{\n  \"dids\": [\"1\",\"2\",\"3\",\"4\"]\n}\n

The above endpoint takes a list of DIDs sent as an array in a POST - application/json body and creates a port with those numbers.

\n","urlObject":{"path":["inbound","port-in","upload","text"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"45d80575-881b-4d17-9656-d53c5022a184","name":"Upload DIDs to Check Port In Availability","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Basic {{auth_string}}"}],"body":{"mode":"raw","raw":"{\n\t\"dids\": [ \"2124569045, 9192327755\" ]\n}"},"url":"https://api.thinq.com/inbound/port-in/upload/text"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Dec 2019 19:23:21 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"X-thinQ-account_id","value":"22054"},{"key":"X-thinQ-username","value":"jriddle22054"},{"key":"Access-Control-Allow-Headers","value":"origin, x-requested-with, content-type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"orderIds\": [\n 4565,\n 4566\n ]\n },\n \"statusCode\": 200,\n \"message\": \"Successfully created port-in process\"\n}"}],"_postman_id":"28c563d2-e13d-41a0-9d2d-39ff08f06fa6"},{"name":"Upload File of DIDs to Check Portin Availablity","id":"10d3b868-c7cc-46c9-96fd-3a910e40276d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"

CSV of DIDs to be checked

\n","key":"file","type":"file","value":null}]},"url":"https://api.thinq.com/inbound/port-in/upload/file","description":"

Body (post request body as multipart/formdata)

\"properties\": {\n    \"file\": { \"type\": \"object\" }\n},\n

This file needs to be a CSV formatted as either of the below examples and sent in the body with the key file as a binary file.

1,2,3,4  \nOR  \n1  \n2  \n3  \n4\n

The above endpoint takes a file and creates a port with those numbers

Both endpoints above respond with a key orderIds which is an array of orders created from your port. The reason why you would get multiple orderIds back is that the port in splits orders by carrier. If you have some numbers which go to one carrier and some numbers which go to another carrier, those orders will be split.

orderIds: { type: 'array', items: { type: 'number' }, example: [1, 2] },\n

","urlObject":{"path":["inbound","port-in","upload","file"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"786a44ad-1196-4613-9062-8a0fa149c861","name":"Upload File of DIDs to Check Portin Availablity","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/Users/avilmin/Downloads/tn_uploads_sample.csv"}]},"url":"https://api.thinq.com/inbound/port-in/upload/file"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Dec 2019 19:49:09 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"X-thinQ-account_id","value":"22054"},{"key":"X-thinQ-username","value":"jriddle22054"},{"key":"Access-Control-Allow-Headers","value":"origin, x-requested-with, content-type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"orderIds\": [\n 4567\n ]\n },\n \"statusCode\": 200,\n \"message\": \"Successfully created port-in process\"\n}"}],"_postman_id":"10d3b868-c7cc-46c9-96fd-3a910e40276d"},{"name":"Get Port In Pricing Information","id":"f9657f74-fde5-458f-8490-09d6a22765ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/account/{{account_id}}/port-in/{{portinId}}/upload/dids","description":"

Generate costs and get port in details to use in confirm

GET https://api.thinq.com/account/:account_id/port-in/:portin_process_id/upload/dids

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}},"urlObject":{"path":["account","{{account_id}}","port-in","{{portinId}}","upload","dids"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"8582dd14-e98f-4873-be98-15c9dfd0b6f2","name":"Get Port In Pricing Information","originalRequest":{"method":"GET","header":[],"url":"https://api.thinq.com/account/{{account_id}}/port-in/{{portinId}}/upload/dids"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"portin\": {\n \"account_id\": \"22054\",\n \"dids\": [\n \"9192327747\",\n \"9192327755\",\n \"9192327751\"\n ],\n \"carrier_id\": null,\n \"status\": \"processing\",\n \"history_status\": {\n \"history\": [\n {\n \"status\": \"processing\",\n \"setted_by\": \"jriddle22054\",\n \"setted_on\": 1576092207,\n \"id\": null,\n \"type\": \"status_history_item\"\n }\n ],\n \"id\": null,\n \"type\": \"status_history\"\n },\n \"order_id\": null,\n \"credit\": [],\n \"rejection_reason\": null,\n \"foc_date\": null,\n \"commit_date\": null,\n \"support_ticket_id\": null,\n \"snapback_allowed\": true,\n \"tag\": null,\n \"isTF\": false,\n \"iqPortinRequestID\": null,\n \"id\": 411,\n \"type\": \"orig_portin_process\",\n \"rejected_dids\": null,\n \"original_dids\": null,\n \"estimated_cost\": null,\n \"draft_feature_order_id\": null,\n \"snapback_mandatory\": null\n },\n \"cost_by_carrier\": [\n {\n \"carrier_id\": 4,\n \"carrier_name\": \"Inteliquent\",\n \"rejected_did_amount\": 0,\n \"cost_by_tier\": 9.6,\n \"subtotal\": 9.6,\n \"taxes\": 0,\n \"total\": 9.6,\n \"summary\": {\n \"did_tiers\": [\n {\n \"tier_id\": 0,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n {\n \"tier_id\": 1,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 3,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0.1,\n \"unit_rc_price\": 0.2,\n \"one_time_price\": 0,\n \"monthly\": 0.6,\n \"rc_price\": 0.6,\n \"nrc_price\": 0,\n \"price\": 0.6,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"list\": [\n \"9192327747\",\n \"9192327755\",\n \"9192327751\"\n ]\n },\n {\n \"tier_id\": 2,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0.1,\n \"unit_rc_price\": 0.25,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n {\n \"tier_id\": 3,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0.1,\n \"unit_rc_price\": 0.25,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n {\n \"tier_id\": 4,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n }\n ],\n \"tollfree\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 1,\n \"unit_rc_price\": 0.5,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"list\": []\n },\n \"porting_tiers\": [\n {\n \"portin_quantity\": 0,\n \"portin_unit_price\": 0,\n \"portin_tax_percentage\": null,\n \"portout_quantity\": 0,\n \"portout_unit_price\": 0,\n \"portout_tax_percentage\": null,\n \"tier_id\": 0,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"in_taxed_price\": 0,\n \"out_taxed_price\": 0\n },\n {\n \"portin_quantity\": 3,\n \"portin_unit_price\": 3,\n \"portin_tax_percentage\": null,\n \"portout_quantity\": 0,\n \"portout_unit_price\": 3,\n \"portout_tax_percentage\": null,\n \"tier_id\": 1,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 9,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"in_taxed_price\": 9,\n \"out_taxed_price\": 0\n },\n {\n \"portin_quantity\": 0,\n \"portin_unit_price\": 8,\n \"portin_tax_percentage\": null,\n \"portout_quantity\": 0,\n \"portout_unit_price\": 3,\n \"portout_tax_percentage\": null,\n \"tier_id\": 2,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"in_taxed_price\": 0,\n \"out_taxed_price\": 0\n },\n {\n \"portin_quantity\": 0,\n \"portin_unit_price\": 8,\n \"portin_tax_percentage\": null,\n \"portout_quantity\": 0,\n \"portout_unit_price\": 3,\n \"portout_tax_percentage\": null,\n \"tier_id\": 3,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"in_taxed_price\": 0,\n \"out_taxed_price\": 0\n },\n {\n \"portin_quantity\": 0,\n \"portin_unit_price\": 0,\n \"portin_tax_percentage\": null,\n \"portout_quantity\": 0,\n \"portout_unit_price\": 0,\n \"portout_tax_percentage\": null,\n \"tier_id\": 4,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"in_taxed_price\": 0,\n \"out_taxed_price\": 0\n }\n ],\n \"porting_tollfree\": {\n \"portin_quantity\": 0,\n \"portin_unit_price\": 2,\n \"portin_tax_percentage\": null,\n \"portout_quantity\": 0,\n \"portout_unit_price\": 3,\n \"portout_tax_percentage\": null,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"in_taxed_price\": 0,\n \"out_taxed_price\": 0\n },\n \"cnam_in\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"cnam_out\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0.5,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"credited\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"e911\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 1,\n \"unit_rc_price\": 1,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"uprvsde911\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"sms\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"sessions\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"portin_cancel\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 175,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"snapback\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 300,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"disconnect_tiers\": [\n {\n \"disconnect_quantity\": 0,\n \"disconnect_unit_price\": 0,\n \"disconnect_tax_percentage\": 0,\n \"tier_id\": 0,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"disconnect_taxed_price\": 0\n },\n {\n \"disconnect_quantity\": 0,\n \"disconnect_unit_price\": 3,\n \"disconnect_tax_percentage\": 0,\n \"tier_id\": 1,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"disconnect_taxed_price\": 0\n },\n {\n \"disconnect_quantity\": 0,\n \"disconnect_unit_price\": 3,\n \"disconnect_tax_percentage\": 0,\n \"tier_id\": 2,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"disconnect_taxed_price\": 0\n },\n {\n \"disconnect_quantity\": 0,\n \"disconnect_unit_price\": 3,\n \"disconnect_tax_percentage\": 0,\n \"tier_id\": 3,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"disconnect_taxed_price\": 0\n },\n {\n \"disconnect_quantity\": 0,\n \"disconnect_unit_price\": 0,\n \"disconnect_tax_percentage\": 0,\n \"tier_id\": 4,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"disconnect_taxed_price\": 0\n }\n ],\n \"disconnect_tollfree\": {\n \"disconnect_quantity\": 0,\n \"disconnect_unit_price\": 2,\n \"disconnect_tax_percentage\": 0,\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\",\n \"disconnect_taxed_price\": 0\n },\n \"cnam_in_hits\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"discounts\": {\n \"porting_tiers\": []\n },\n \"usage_regular_mms_in\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_regular_mms_out\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_regular_sms_in\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_regular_sms_out\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_tollfree_mms_in\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_tollfree_mms_out\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_tollfree_sms_in\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"usage_tollfree_sms_out\": {\n \"nrc_quantity\": 0,\n \"rc_quantity\": 0,\n \"nrc_tax_percentage\": 0,\n \"rc_tax_percentage\": 0,\n \"unit_nrc_price\": 0,\n \"unit_rc_price\": 0,\n \"one_time_price\": 0,\n \"monthly\": 0,\n \"rc_price\": 0,\n \"nrc_price\": 0,\n \"price\": 0,\n \"metered_Id\": null,\n \"id\": null,\n \"type\": \"order_summary_line\"\n },\n \"credited_amount\": 0,\n \"type\": \"order_summary\"\n },\n \"tier_quantity_and_price\": [],\n \"tier_detail\": [\n {\n \"nrc_price\": 0,\n \"rc_price\": 0,\n \"subtotal\": 0,\n \"taxes\": 0,\n \"portin_quantity\": 0,\n \"dids\": null\n },\n {\n \"nrc_price\": 9,\n \"rc_price\": 0.6,\n \"subtotal\": 0.6,\n \"taxes\": 0,\n \"portin_quantity\": 3,\n \"dids\": [\n \"9192327747\",\n \"9192327755\",\n \"9192327751\"\n ]\n },\n {\n \"nrc_price\": 0,\n \"rc_price\": 0,\n \"subtotal\": 0,\n \"taxes\": 0,\n \"portin_quantity\": 0,\n \"dids\": null\n },\n {\n \"nrc_price\": 0,\n \"rc_price\": 0,\n \"subtotal\": 0,\n \"taxes\": 0,\n \"portin_quantity\": 0,\n \"dids\": null\n },\n {\n \"nrc_price\": 0,\n \"rc_price\": 0,\n \"subtotal\": 0,\n \"taxes\": 0,\n \"portin_quantity\": 0,\n \"dids\": null\n }\n ],\n \"tf_detail\": {\n \"nrc_price\": 0,\n \"rc_price\": 0,\n \"taxes\": 0,\n \"subtotal\": 0,\n \"portin_quantity\": 0,\n \"dids\": []\n }\n }\n ],\n \"filename\": \"58de83b15490577ad205a4b1a199cde9.csv\"\n}"}],"_postman_id":"f9657f74-fde5-458f-8490-09d6a22765ae"},{"name":"Confirm Port In (non-TF)","id":"5d86dce0-89e9-4799-b6d4-5416fde646df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.thinq.com/account/{{account_id}}/port-in/{{portinId}}/confirm","description":"

Send confirmation details, request FOC date, and confirm port submission

POST https://api.thinq.com/account/:account_id/port-in/:portin_process_id/confirm

Send requested FOC date, LOA PDF and optional carrier bill, to confirm port submission

POST https://api.thinq.com/account/:account_id/port-in/:portin_process_id/confirm

Get information about a single port

GET https://api.thinq.com/account/:account_id/port-in/:portin_process_id/tracking

CSV of DIDs to be checked

\n","key":"file","type":"file","value":null}]},"url":"https://api.thinq.com/account/{{account_id}}/port-in/{{portinId}}/upload/files/loa","description":"

For Toll Free numbers, the LOA submission is required and must be a pdf file

The {{portinId}} is provided in the previous requests

\n","urlObject":{"path":["account","{{account_id}}","port-in","{{portinId}}","upload","files","loa"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"c936876a-2618-4798-b955-2f73b0ce08ed","name":"LOA upload","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/Users/avilmin/Downloads/tn_uploads_sample.csv"}]},"url":"https://api.thinq.com/account/{{account_id}}/port-in/{{portinId}}/upload/files/loa"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Dec 2019 19:49:09 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"X-thinQ-account_id","value":"22054"},{"key":"X-thinQ-username","value":"jriddle22054"},{"key":"Access-Control-Allow-Headers","value":"origin, x-requested-with, content-type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"file_ticket\":\"{{portinId}}::loa\"\n}"}],"_postman_id":"9386fd09-919b-45e9-abbf-2d9ad897e05f"},{"name":"Upload BILL for Toll Free numbers port in","id":"ffe6e7d6-f0f4-4be6-827f-56910654a93d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"

CSV of DIDs to be checked

\n","key":"file","type":"file","value":null}]},"url":"https://api.thinq.com/account/{{account_id}}/port-in/{{portinId}}/upload/files/bill","description":"

For Toll Free numbers, the BILL submission is optional

The {{portinId}} is provided in the previous requests

\n","urlObject":{"path":["account","{{account_id}}","port-in","{{portinId}}","upload","files","bill"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"6c4d86d1-ab3e-4e89-b695-12a9f18b8948","name":"BILL upload","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/Users/avilmin/Downloads/tn_uploads_sample.csv"}]},"url":"https://api.thinq.com/account/{{account_id}}/port-in/{{portinId}}/upload/files/bill"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Dec 2019 19:49:09 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"X-thinQ-account_id","value":"22054"},{"key":"X-thinQ-username","value":"jriddle22054"},{"key":"Access-Control-Allow-Headers","value":"origin, x-requested-with, content-type, Authorization"},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"file_ticket\":\"{{portinId}}::bill\"\n}"}],"_postman_id":"ffe6e7d6-f0f4-4be6-827f-56910654a93d"},{"name":"Add internal note for your port","id":"8e34e743-3618-45de-8216-b0418e75a225","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.thinq.com/account/{{account_id}}/port-in/{{portinId}}/tag","description":"

For Toll Free numbers, the BILL submission is optional

The {{portinId}} is provided in the previous requests

\n","urlObject":{"path":["account","{{account_id}}","port-in","{{portinId}}","tag"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8e34e743-3618-45de-8216-b0418e75a225"}],"id":"fa4c38b5-a6fa-4513-be3d-1dc5fdbb29ef","_postman_id":"fa4c38b5-a6fa-4513-be3d-1dc5fdbb29ef","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Reporting","item":[{"name":"Retrieve Usage Date Range","event":[{"listen":"test","script":{"exec":["//tests[\"Status code is 200\"] = responseCode.code === 200;","//var jsonData = JSON.parse(responseBody);",""],"id":"25f7ec76-3f39-4425-b211-d02395ac7d53","type":"text/javascript"}},{"listen":"prerequest","script":{"exec":["pm.environment.set(\"usage_start_date\", \"2017-01-01\");","pm.environment.set(\"usage_end_date\", \"2017-09-09\");"],"id":"c0f14d88-a938-40a4-a307-38eca81fed20","type":"text/javascript"}}],"id":"4a232cb1-c07a-4628-95ab-1bcb33a31a86","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/usage/origination/{{account_id}}/range/{{usage_start_date}}/{{usage_end_date}}","description":"

Retrieve all of the usage data withing your account using a start and end date.

\n","urlObject":{"path":["usage","origination","{{account_id}}","range","{{usage_start_date}}","{{usage_end_date}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"d6d2e118-2d63-419c-a4a7-0f113a6b7352","name":"Retrieve Usage Date Range","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/usage/origination/{{account_id}}/range/{{usage_start_date}}/{{usage_end_date}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"usage\": {\n \"2017\": {\n \"1\": {\n \"17\": {\n \"minutes\": 59210.2,\n \"retail\": 354.76592,\n \"tiers\": {\n \"0\": {\n \"minutes\": 20654.2,\n \"retail\": 200.94342,\n \"average_rate\": 0.00972893745582\n },\n \"1\": {\n \"minutes\": 24968,\n \"retail\": 62.42,\n \"average_rate\": 0.0025\n },\n \"2\": {\n \"minutes\": 6177.9,\n \"retail\": 24.7116,\n \"average_rate\": 0.004\n },\n \"3\": {\n \"minutes\": 7410.1,\n \"retail\": 66.6909,\n \"average_rate\": 0.009\n }\n },\n \"carriers\": {\n \"Inteliquent\": {\n \"minutes\": 111,\n \"retail\": 0.33455,\n \"profiles\": {\n \"\": {\n \"minutes\": 111,\n \"retail\": 0.33455,\n \"profile_id\": \"\",\n \"id\": \"\",\n \"average_rate\": 0.00301396396396\n }\n },\n \"average_rate\": 0.00301396396396\n },\n \"Verizon\": {\n \"minutes\": 276.6,\n \"retail\": 1.81833,\n \"profiles\": {\n \"\": {\n \"minutes\": 208.9,\n \"retail\": 1.47831,\n \"profile_id\": \"\",\n \"id\": \"\",\n \"average_rate\": 0.00707663954045\n },\n \"Test\": {\n \"minutes\": 67.7,\n \"retail\": 0.34002,\n \"profile_id\": 208,\n \"id\": 208,\n \"average_rate\": 0.00502245199409\n }\n },\n \"average_rate\": 0.00657386117137\n },\n \"Level 3\": {\n \"minutes\": 63.2,\n \"retail\": 0.83585,\n \"profiles\": {\n \"\": {\n \"minutes\": 44,\n \"retail\": 0.59409,\n \"profile_id\": \"\",\n \"id\": \"\",\n \"average_rate\": 0.0135020454545\n },\n \"Test\": {\n \"minutes\": 19.2,\n \"retail\": 0.24176,\n \"profile_id\": 208,\n \"id\": 208,\n \"average_rate\": 0.0125916666667\n }\n },\n \"average_rate\": 0.0132254746835\n },\n \"CenturyLink\": {\n \"minutes\": 80.8,\n \"retail\": 0.78712,\n \"profiles\": {\n \"\": {\n \"minutes\": 57.1,\n \"retail\": 0.55516,\n \"profile_id\": \"\",\n \"id\": \"\",\n \"average_rate\": 0.00972259194396\n },\n \"Test\": {\n \"minutes\": 23.7,\n \"retail\": 0.23196,\n \"profile_id\": 208,\n \"id\": 208,\n \"average_rate\": 0.00978734177215\n }\n },\n \"average_rate\": 0.00974158415842\n },\n \"AT&T\": {\n \"minutes\": 20233.6,\n \"retail\": 197.50212,\n \"profiles\": {\n \"\": {\n \"minutes\": 18847.1,\n \"retail\": 185.62543,\n \"profile_id\": \"\",\n \"id\": \"\",\n \"average_rate\": 0.00984901815133\n },\n \"Test\": {\n \"minutes\": 1386.5,\n \"retail\": 11.87669,\n \"profile_id\": 208,\n \"id\": 208,\n \"average_rate\": 0.0085659502344\n }\n },\n \"average_rate\": 0.00976109639412\n }\n },\n \"retail_after_tax\": 1255.53324782,\n \"average_rate\": 0.00599163522501\n },\n \"18\": {\n \"minutes\": 46153.8,\n \"retail\": 246.51919,\n \"tiers\": {\n \"0\": {\n \"minutes\": 10056.5,\n \"retail\": 101.68544,\n \"average_rate\": 0.010111414508\n },\n \"1\": {\n \"minutes\": 23079.3,\n \"retail\": 57.69825,\n \"average_rate\": 0.0025\n },\n \"2\": {\n \"minutes\": 6005.3,\n \"retail\": 24.0212,\n \"average_rate\": 0.004\n },\n \"3\": {\n \"minutes\": 7012.7,\n \"retail\": 63.1143,\n \"average_rate\": 0.009\n }\n },\n \"carriers\": {\n \"Inteliquent\": {\n \"minutes\": 91.6,\n \"retail\": 0.2953,\n \"profiles\": {\n \"\": {\n \"minutes\": 91.6,\n \"retail\": 0.2953,\n \"profile_id\": \"\",\n \"id\": \"\",\n \"average_rate\": 0.00322379912664\n }\n },\n \"average_rate\": 0.00322379912664\n },\n \"Verizon\": {\n \"minutes\": 108.7,\n \"retail\": 0.59475,\n \"profiles\": {\n \"\": {\n \"minutes\": 108.5,\n \"retail\": 0.59303,\n \"profile_id\": \"\",\n \"id\": \"\",\n \"average_rate\": 0.00546571428571\n },\n \"Test\": {\n \"minutes\": 0.2,\n \"retail\": 0.00172,\n \"profile_id\": 208,\n \"id\": 208,\n \"average_rate\": 0.0086\n }\n },\n \"average_rate\": 0.00547148114075\n },\n \"Level 3\": {\n \"minutes\": 35.8,\n \"retail\": 0.49799,\n \"profiles\": {\n \"\": {\n \"minutes\": 34.8,\n \"retail\": 0.48669,\n \"profile_id\": \"\",\n \"id\": \"\",\n \"average_rate\": 0.0139853448276\n },\n \"Test\": {\n \"minutes\": 1,\n \"retail\": 0.0113,\n \"profile_id\": 208,\n \"id\": 208,\n \"average_rate\": 0.0113\n }\n },\n \"average_rate\": 0.0139103351955\n },\n \"CenturyLink\": {\n \"minutes\": 10.4,\n \"retail\": 0.1676,\n \"profiles\": {\n \"\": {\n \"minutes\": 8.4,\n \"retail\": 0.147,\n \"profile_id\": \"\",\n \"id\": \"\",\n \"average_rate\": 0.0175\n },\n \"Test\": {\n \"minutes\": 2,\n \"retail\": 0.0206,\n \"profile_id\": 208,\n \"id\": 208,\n \"average_rate\": 0.0103\n }\n },\n \"average_rate\": 0.0161153846154\n },\n \"AT&T\": {\n \"minutes\": 9901.6,\n \"retail\": 100.4251,\n \"profiles\": {\n \"\": {\n \"minutes\": 9857.8,\n \"retail\": 99.95992,\n \"profile_id\": \"\",\n \"id\": \"\",\n \"average_rate\": 0.0101401854369\n },\n \"Test\": {\n \"minutes\": 43.8,\n \"retail\": 0.46518,\n \"profile_id\": 208,\n \"id\": 208,\n \"average_rate\": 0.0106205479452\n }\n },\n \"average_rate\": 0.0101423103337\n }\n },\n \"retail_after_tax\": 961.413807168,\n \"average_rate\": 0.00534125445792\n }\n }\n }\n },\n \"totals\": {\n \"minutes\": 105364,\n \"retail\": 601.28511,\n \"carriers\": {\n \"Inteliquent\": {\n \"minutes\": 202.6,\n \"retail\": 0.62985,\n \"average_rate\": 0.00310883514314\n },\n \"Verizon\": {\n \"minutes\": 385.3,\n \"retail\": 2.41308,\n \"average_rate\": 0.00626286010901\n },\n \"Level 3\": {\n \"minutes\": 99,\n \"retail\": 1.33384,\n \"average_rate\": 0.0134731313131\n },\n \"CenturyLink\": {\n \"minutes\": 91.2,\n \"retail\": 0.95472,\n \"average_rate\": 0.0104684210526\n },\n \"AT&T\": {\n \"minutes\": 30135.2,\n \"retail\": 297.92722,\n \"average_rate\": 0.00988635283655\n }\n },\n \"tiers\": {\n \"0\": {\n \"minutes\": 30710.7,\n \"retail\": 302.62886,\n \"average_rate\": 0.00985418306974\n },\n \"1\": {\n \"minutes\": 48047.3,\n \"retail\": 120.11825,\n \"average_rate\": 0.0025\n },\n \"2\": {\n \"minutes\": 12183.2,\n \"retail\": 48.7328,\n \"average_rate\": 0.004\n },\n \"3\": {\n \"minutes\": 14422.8,\n \"retail\": 129.8052,\n \"average_rate\": 0.009\n }\n },\n \"retail_after_tax\": 2216.94705499,\n \"average_rate\": 0.00570674148666\n }\n}"}],"_postman_id":"4a232cb1-c07a-4628-95ab-1bcb33a31a86"},{"name":"Retrieve Usage Whole Year/Month/Day","event":[{"listen":"test","script":{"exec":["//tests[\"Status code is 200\"] = responseCode.code === 200;","//var jsonData = JSON.parse(responseBody);",""],"id":"db3e50ea-72c3-430d-9898-cdfa422247bd","type":"text/javascript"}},{"listen":"prerequest","script":{"exec":["pm.environment.set(\"usage_year\", \"2017\");","pm.environment.set(\"usage_month\", \"9\");","pm.environment.set(\"usage_day\", \"1\");"],"id":"26431973-b7d1-4805-9681-880f437ed967","type":"text/javascript"}}],"id":"00d10875-33ea-42d2-b3d4-05ea4408dbaa","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/usage/origination/{{account_id}}/{{usage_year}}/{{usage_month}}/{{usage_day}}","urlObject":{"path":["usage","origination","{{account_id}}","{{usage_year}}","{{usage_month}}","{{usage_day}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"4a40e1b7-3efb-4445-8708-a4112fffc75c","name":"Retrieve Usage Whole Year/Month/Day copy","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/usage/origination/{{account_id}}/{{usage_year}}/{{usage_month}}/{{usage_day}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"usage\": {\n \"2017\": {\n \"1\": {\n \"1\": {\n \"minutes\": 14272.7,\n \"retail\": 55.67446,\n \"tiers\": {\n \"0\": {\n \"minutes\": 51.7,\n \"retail\": 0.42941,\n \"average_rate\": 0.00830580270793\n },\n \"1\": {\n \"minutes\": 9593.3,\n \"retail\": 23.98325,\n \"average_rate\": 0.0025\n },\n \"2\": {\n \"minutes\": 2077.5,\n \"retail\": 8.31,\n \"average_rate\": 0.004\n },\n \"3\": {\n \"minutes\": 2550.2,\n \"retail\": 22.9518,\n \"average_rate\": 0.009\n }\n },\n \"carriers\": {\n \"Inteliquent\": {\n \"minutes\": 32.6,\n \"retail\": 0.0928,\n \"profiles\": {\n \"\": {\n \"minutes\": 32.6,\n \"retail\": 0.0928,\n \"profile_id\": \"\",\n \"id\": \"\",\n \"average_rate\": 0.00284662576687\n }\n },\n \"average_rate\": 0.00284662576687\n },\n \"Verizon\": {\n \"minutes\": 0.2,\n \"retail\": 0.016,\n \"profiles\": {\n \"Default\": {\n \"minutes\": 0.2,\n \"retail\": 0.016,\n \"profile_id\": 0,\n \"id\": 0,\n \"average_rate\": 0.08\n }\n },\n \"average_rate\": 0.08\n },\n \"Level 3\": {\n \"minutes\": 1,\n \"retail\": 0.01479,\n \"profiles\": {\n \"Default\": {\n \"minutes\": 1,\n \"retail\": 0.01479,\n \"profile_id\": 0,\n \"id\": 0,\n \"average_rate\": 0.01479\n }\n },\n \"average_rate\": 0.01479\n },\n \"CenturyLink\": {\n \"minutes\": 0.3,\n \"retail\": 0.00228,\n \"profiles\": {\n \"Default\": {\n \"minutes\": 0.3,\n \"retail\": 0.00228,\n \"profile_id\": 0,\n \"id\": 0,\n \"average_rate\": 0.0076\n }\n },\n \"average_rate\": 0.0076\n },\n \"AT&T\": {\n \"minutes\": 50.2,\n \"retail\": 0.39634,\n \"profiles\": {\n \"Default\": {\n \"minutes\": 50.2,\n \"retail\": 0.39634,\n \"profile_id\": 0,\n \"id\": 0,\n \"average_rate\": 0.00789521912351\n }\n },\n \"average_rate\": 0.00789521912351\n }\n },\n \"retail_after_tax\": 270.958759591,\n \"average_rate\": 0.00390076579764\n }\n }\n }\n },\n \"totals\": {\n \"minutes\": 14272.7,\n \"retail\": 55.67446,\n \"carriers\": {\n \"Inteliquent\": {\n \"minutes\": 32.6,\n \"retail\": 0.0928,\n \"average_rate\": 0.00284662576687\n },\n \"Verizon\": {\n \"minutes\": 0.2,\n \"retail\": 0.016,\n \"average_rate\": 0.08\n },\n \"Level 3\": {\n \"minutes\": 1,\n \"retail\": 0.01479,\n \"average_rate\": 0.01479\n },\n \"CenturyLink\": {\n \"minutes\": 0.3,\n \"retail\": 0.00228,\n \"average_rate\": 0.0076\n },\n \"AT&T\": {\n \"minutes\": 50.2,\n \"retail\": 0.39634,\n \"average_rate\": 0.00789521912351\n }\n },\n \"tiers\": {\n \"0\": {\n \"minutes\": 51.7,\n \"retail\": 0.42941,\n \"average_rate\": 0.00830580270793\n },\n \"1\": {\n \"minutes\": 9593.3,\n \"retail\": 23.98325,\n \"average_rate\": 0.0025\n },\n \"2\": {\n \"minutes\": 2077.5,\n \"retail\": 8.31,\n \"average_rate\": 0.004\n },\n \"3\": {\n \"minutes\": 2550.2,\n \"retail\": 22.9518,\n \"average_rate\": 0.009\n }\n },\n \"retail_after_tax\": 270.958759591,\n \"average_rate\": 0.00390076579764\n }\n}"}],"_postman_id":"00d10875-33ea-42d2-b3d4-05ea4408dbaa"},{"name":"Search Uncompleted Calls","event":[{"listen":"test","script":{"exec":["//tests[\"Status code is 200\"] = responseCode.code === 200;","//var jsonData = JSON.parse(responseBody);",""],"id":"93fce14c-3fbd-4c1b-8d0b-bbc95d4f3a63","type":"text/javascript"}}],"id":"7a34f5a8-1a80-4f4b-8f34-c1d77386635e","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":"{\"query\":\n {\n \"from_date\": \"2017-1-22\",\n \"to_date\": \"2017-9-24\",\n \"from_ani\": null,\n \"to_did\": null,\n \"callid\":null\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/diagnosis/failed_calls","description":"

Retrieve an array of all uncompleted calls within a specific date range. The to and from dates can be added to the body of the request.

\n","urlObject":{"path":["account","{{account_id}}","origination","diagnosis","failed_calls"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"086af981-125b-49f8-b3ca-2e7fc2280df7","name":"Search Failed Calls","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":"{\"query\":\n {\n \"from_date\": \"2017-1-22\",\n \"to_date\": \"2017-9-24\",\n \"from_ani\": null,\n \"to_did\": null,\n \"callid\":null\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/diagnosis/failed_calls"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total_rows\": \"26\",\n \"has_next_page\": true,\n \"page\": 1,\n \"rows_per_page\": 1,\n \"rows\": [\n {\n \"date\": \"2017-03-23\",\n \"method\": \"INVITE\",\n \"from_did\": \"XXXXXXXXXX\",\n \"to_did\": \"XXXXXXXXXX\",\n \"lrn\": \"XXXXXXXXXX\",\n \"callid\": \"XXX\",\n \"sip_code\": \"487\",\n \"sip_reason\": \"Request Terminated\",\n \"time\": \"2017-03-23 00:30:15\",\n \"carrier_id\": \"75\",\n \"account_id\": \"XXX\",\n \"srcip\": \"XXX.XXX.XX.XX\",\n \"switchip\": \"XXX.XXX.XX.XX\",\n \"retail\": \"0.00250000\",\n \"from_state\": \"IL\",\n \"to_state\": \"IL\",\n \"from_rc\": \"CHICGOZN10\",\n \"to_rc\": \"CHICGOZN01\",\n \"from_lata\": \"358\",\n \"from_lrn_lata\": \"358\",\n \"to_lata\": \"358\",\n \"from_ocn\": \"6534\",\n \"from_lrn_ocn\": \"6534\",\n \"from_lrn_company\": \"NEW CINGULAR WIRELESS PCS, LLC - IL\",\n \"to_ocn\": \"278D\",\n \"to_lrn\": \"XXXXXXXXXX\",\n \"jurisdiction\": \"A\",\n \"type\": \"IP\",\n \"dest\": \"XXX.XXX.XX.XX\",\n \"cause\": null,\n \"thinq_tier\": \"1\",\n \"profile_id\": \"\"\n }\n ],\n \"filename\": \"CDR_Diagnosis_XXXXXXXXXXX.csv\"\n}"}],"_postman_id":"7a34f5a8-1a80-4f4b-8f34-c1d77386635e"},{"name":"Download Uncompleted Calls","event":[{"listen":"test","script":{"id":"00d479d4-716d-45f7-a122-88700d5612d0","type":"text/javascript","exec":[""]}}],"id":"6f79b40d-555f-4ef7-819c-643e48585970","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":"{\"query\":\n {\n \"from_date\": \"2017-3-22\",\n \"to_date\": \"2017-3-24\",\n \"from_ani\": null,\n \"to_did\": null,\n \"callid\":null\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/diagnosis/failed_calls/download","description":"

Retrieve a text file of all uncompleted calls within a specific date range. The to and from dates can be added to the body of the request.

\n","urlObject":{"path":["account","{{account_id}}","origination","diagnosis","failed_calls","download"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"c0e568c9-6b40-4b78-b0f0-c6bc3e8af4e9","name":"Download Failed Calls","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":"{\"query\":\n {\n \"from_date\": \"2017-3-22\",\n \"to_date\": \"2017-3-24\",\n \"from_ani\": null,\n \"to_did\": null,\n \"callid\":null\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/diagnosis/failed_calls/download"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"\"date\",\"method\",\"from_did\",\"to_did\",\"lrn\",\"callid\",\"sip_code\",\"sip_reason\",\"time\",\"carrier_id\",\"account_id\",\"srcip\",\"switchip\",\"retail\",\"from_state\",\"to_state\",\"from_rc\",\"to_rc\",\"from_lata\",\"from_lrn_lata\",\"to_lata\",\"from_ocn\",\"from_lrn_ocn\",\"from_lrn_company\",\"to_ocn\",\"to_lrn\",\"jurisdiction\",\"type\",\"dest\",\"cause\",\"thinq_tier\",\"profile_id\"\n\"2017-03-23\",\"INVITE\",\"XXXXXXXXXX\",\"XXXXXXXXXX\",\"XXXXXXXXXX\",\"XXXXX\",\"487\",\"Request Terminated\",\"2017-03-23 05:04:13\",\"75\",\"XXX\",\"XXX.XXX.XX.XX\",\"XXX.XXX.XX.XX\",\"0.00250000\",\"WA\",\"WA\",\"SEATTLE\",\"SEATTLE\",\"674\",\"674\",\"674\",\"6529\",\"6529\",\"T-MOBILE USA, INC.\",\"712G\",\"XXXXXXXXXX\",\"A\",\"IP\",\"XXX.XXX.XX.XX\",\"\",\"1\",\"\"\n\"2017-03-23\",\"INVITE\",\"XXXXXXXXXX\",\"XXXXXXXXXX\",\"XXXXXXXXXX\",\"XXXXX\",\"487\",\"Request Terminated\",\"2017-03-23 05:04:23\",\"75\",\"XXX\",\"XXX.XXX.XX.XX\",\"XXX.XXX.XX.XX\",\"0.00250000\",\"WA\",\"WA\",\"SEATTLE\",\"SEATTLE\",\"674\",\"674\",\"674\",\"6529\",\"6529\",\"T-MOBILE USA, INC.\",\"712G\",\"XXXXXXXXXX\",\"A\",\"IP\",\"XXX.XXX.XX.XX\",\"\",\"1\",\"\""}],"_postman_id":"6f79b40d-555f-4ef7-819c-643e48585970"},{"name":"Search Completed Calls","event":[{"listen":"test","script":{"id":"557d5466-8f61-418d-ba81-9ecbfbeded1b","exec":["//tests[\"Status code is 200\"] = responseCode.code === 200;","//var jsonData = JSON.parse(responseBody);",""],"type":"text/javascript"}}],"id":"c8ae3508-e6fe-44da-9a5d-006aa85c798e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":"{\"query\":\n {\n \"from_date\": \"2017-01-10\",\n \"to_date\": \"2017-12-12\",\n \"from_ani\": null,\n \"to_did\": null,\n \"callid\":null\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/diagnosis/cdr","description":"

Retrieve an array of all completed calls within a specific date range. The to and from dates can be added to the body of the request.

\n","urlObject":{"path":["account","{{account_id}}","origination","diagnosis","cdr"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"eeca33e2-72fe-4e09-983c-7225ed65dcdb","name":"Search Completed Calls","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":"{\"query\":\n {\n \"from_date\": \"2017-01-10\",\n \"to_date\": \"2017-12-12\",\n \"from_ani\": null,\n \"to_did\": null,\n \"callid\":null\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/diagnosis/cdr"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total_rows\": \"65952\",\n \"has_next_page\": true,\n \"page\": 1,\n \"rows_per_page\": 1,\n \"rows\": [\n {\n \"date\": \"2017-09-10\",\n \"method\": \"INVITE\",\n \"from_did\": \"XXXXXXXXXX\",\n \"to_did\": null,\n \"lrn\": null,\n \"callid\": \"XXX\",\n \"sip_code\": \"200\",\n \"sip_reason\": \"OK\",\n \"time\": \"2017-09-10 00:00:00\",\n \"carrier_id\": null,\n \"account_id\": \"XXXS\",\n \"srcip\": null,\n \"switchip\": null,\n \"retail\": null,\n \"total_retail\": \"0.00075000\",\n \"from_state\": null,\n \"to_state\": null,\n \"from_rc\": null,\n \"to_rc\": null,\n \"from_lata\": null,\n \"from_lrn_lata\": null,\n \"to_lata\": null,\n \"from_ocn\": null,\n \"from_lrn_ocn\": null,\n \"from_lrn_company\": null,\n \"to_ocn\": null,\n \"billable\": null,\n \"jurisdiction\": null,\n \"type\": null,\n \"dest\": null,\n \"thinq_tier\": null,\n \"profile_id\": null\n }\n ],\n \"filename\": \"CDR_Diagnosis_892afaf0fac4e1bb13ca72f2490583fe.csv\"\n}"}],"_postman_id":"c8ae3508-e6fe-44da-9a5d-006aa85c798e"},{"name":"Download Completed Calls","event":[{"listen":"test","script":{"exec":["// *Returns CSV formatted results of all records found by payload parameters","","//tests[\"Status code is 200\"] = responseCode.code === 200;","//var jsonData = JSON.parse(responseBody);","//console.log(jsonData);",""],"id":"a1056e08-73a8-4e54-ae6f-4c6f687ca6fa","type":"text/javascript"}}],"id":"0877382e-ca5d-4fd7-abfc-9971bdb5de97","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":"{\"query\":\n {\n \"from_date\": \"2017-01-10\",\n \"to_date\": \"2017-09-12\",\n \"from_ani\": null,\n \"to_did\": null,\n \"callid\":null\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/diagnosis/cdr/download","description":"

Retrieve a text file of all completed calls within a specific date range. The to and from dates can be added to the body of the request.

\n","urlObject":{"path":["account","{{account_id}}","origination","diagnosis","cdr","download"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"132ab2c7-38e3-4bc3-9e1b-9b5ea5c0e5c2","name":"Download Completed Calls","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":"{\"query\":\n {\n \"from_date\": \"2017-01-10\",\n \"to_date\": \"2017-09-12\",\n \"from_ani\": null,\n \"to_did\": null,\n \"callid\":null\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/diagnosis/cdr/download"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"\"date\",\"method\",\"from_did\",\"to_did\",\"lrn\",\"callid\",\"sip_code\",\"sip_reason\",\"time\",\"carrier_id\",\"account_id\",\"srcip\",\"switchip\",\"retail\",\"total_retail\",\"from_state\",\"to_state\",\"from_rc\",\"to_rc\",\"from_lata\",\"from_lrn_lata\",\"to_lata\",\"from_ocn\",\"from_lrn_ocn\",\"from_lrn_company\",\"to_ocn\",\"billable\",\"jurisdiction\",\"type\",\"dest\",\"thinq_tier\",\"profile_id\"\n\"2017-09-10\",\"INVITE\",\"XXXXXXXXXX\",\"\",\"\",\"XXXXXX\",\"200\",\"OK\",\"2017-02-10 00:00:04\",\"\",\"XXX\",\"\",\"\",\"\",\"0.00100000\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\"\n\"2017-09-11\",\"INVITE\",\"XXXXXXXXXX\",\"\",\"\",\"XXXXXX\",\"200\",\"OK\",\"2017-02-10 00:00:04\",\"\",\"XXX\",\"\",\"\",\"\",\"0.00100000\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\""}],"_postman_id":"0877382e-ca5d-4fd7-abfc-9971bdb5de97"},{"name":"Retrieve Account Balance","id":"54141401-8a57-4e2d-b815-77c895299d60","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.thinq.com/account/{{account_id}}/balance","description":"

Retrieve live account balance

\n","urlObject":{"path":["account","{{account_id}}","balance"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"54141401-8a57-4e2d-b815-77c895299d60"}],"id":"f92c5a92-a917-49a9-a046-6f4d1f9b54a0","description":"

Get important information about your account

\n","_postman_id":"f92c5a92-a917-49a9-a046-6f4d1f9b54a0","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Routing Profiles","item":[{"name":"Create New inbound Profile","event":[{"listen":"test","script":{"exec":["//tests[\"Status code is 200\"] = responseCode.code === 200;","var jsonData = JSON.parse(responseBody);","pm.environment.set(\"route_profile_id\", jsonData.profile.id);",""],"id":"1d55bfc3-24bb-4485-9c8c-696e74740838","type":"text/javascript"}},{"listen":"prerequest","script":{"exec":["pm.environment.set(\"route_to_ip\", \"205.130.130.130\");","pm.environment.set(\"route_to_ip2\", \"205.130.130.131\");","pm.environment.set(\"route_port\", \"5500\");","pm.environment.set(\"route_port2\", \"5501\");","pm.environment.set(\"route_to_pstn\", \"19191234567\");","pm.environment.set(\"route_to_pstn2\", \"19191234568\");"],"id":"e0083cd5-50fb-4612-af47-9bc582a9b639","type":"text/javascript"}}],"id":"77e38792-815e-496d-8059-ba8612a3e80c","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":"{\n \"profile\": {\n \"name\": \"Postman Test Profile\",\n \"inboundRoutes\": [\n {\n \"routeType\": \"IP\",\n \"routeToAddress\": \"{{route_to_ip}}\",\n \"routePort\": \"{{route_port}}\"\n },\n {\n \"routeType\": \"PSTN\",\n \"routePort\": \"{{route_port}}\",\n \"routeToAddress\": \"{{route_to_pstn}}\"\n }\n ]\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/staticinrouteprofile/","description":"

Use this to create a new inbound routing profile.

\n","urlObject":{"path":["account","{{account_id}}","staticinrouteprofile",""],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"58811498-880a-485b-a9d4-6a29d4b4da47","name":"Create New inbound Profile","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":"{\n \"profile\": {\n \"name\": \"Postman Test Profile\",\n \"inboundRoutes\": [\n {\n \"routeType\": \"IP\",\n \"routeToAddress\": \"{{route_to_ip}}\",\n \"routePort\": \"{{route_port}}\"\n },\n {\n \"routeType\": \"PSTN\",\n \"routePort\": \"{{route_port}}\",\n \"routeToAddress\": \"{{route_to_pstn}}\"\n }\n ]\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/staticinrouteprofile/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Test Route\",\n \"inboundRoutes\": [\n {\n \"routeType\": \"IP\",\n \"routeToAddress\": \"XXX.XXX.XX.XX\",\n \"routePort\": XX,\n \"type\": \"route\"\n },\n {\n \"routeType\": \"PSTN\",\n \"routeToAddress\": \"1919XXXXXXX\",\n \"routePort\": null,\n \"type\": \"route\"\n }\n ],\n \"usedByTimedRoutingGroups\": [],\n \"id\": XXX,\n \"type\": \"InRouteGroup\"\n }\n}"}],"_postman_id":"77e38792-815e-496d-8059-ba8612a3e80c"},{"name":"List Existing Inbound Profiles","event":[{"listen":"test","script":{"id":"890cb8c5-fc02-4986-a601-ca554bda9137","type":"text/javascript","exec":[""]}}],"id":"0ee826f3-0a23-4848-a893-344c4f5904bc","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/account/{{account_id}}/staticinrouteprofile","description":"

Use this to get a list of the existing inbound routing profiles associated with your account.

\n","urlObject":{"path":["account","{{account_id}}","staticinrouteprofile"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"7b40ff0d-20e3-48ce-b154-063fade2200a","name":"List Existing Inbound Profiles","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/staticinrouteprofile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total_rows\": 5,\n \"has_next_page\": false,\n \"page\": 5,\n \"rows_per_page\": 1,\n \"rows\": [\n {\n \"subType\": \"static\",\n \"name\": \"Test Profile\",\n \"inboundRoutes\": [\n {\n \"routeType\": \"IP\",\n \"routeToAddress\": \"XXX.XXX.XX.XX\",\n \"routePort\": XX,\n \"type\": \"route\"\n },\n {\n \"routeType\": \"PSTN\",\n \"routeToAddress\": \"1919XXXXXXX\",\n \"routePort\": null,\n \"type\": \"route\"\n }\n ],\n \"usedByTimedRoutingGroups\": null,\n \"id\": XXX,\n \"type\": \"InRouteGroup\",\n \"default\": false\n }\n ]\n}"}],"_postman_id":"0ee826f3-0a23-4848-a893-344c4f5904bc"},{"name":"Retrieve Single Inbound Profile","event":[{"listen":"test","script":{"exec":["//tests[\"Status code is 200\"] = responseCode.code === 200;","//var jsonData = JSON.parse(responseBody);",""],"id":"1fa1d883-805f-40f6-bb53-54aba88775fe","type":"text/javascript"}}],"id":"a9b4ad2b-1e8e-4ce1-b818-b73a81e7f3a7","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"url":"https://api.thinq.com/account/{{account_id}}/staticinrouteprofile/{{route_profile_id}}","description":"

Use this to get details about a single inbound routing profile.

\n","urlObject":{"path":["account","{{account_id}}","staticinrouteprofile","{{route_profile_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"47f0f71f-2727-4ccd-800b-030d6fa00ae1","name":"Retrieve Single Inbound Profile","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/staticinrouteprofile/{{route_profile_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"profile\": {\n \"subType\": \"static\",\n \"name\": \"Test Profile\",\n \"inboundRoutes\": [\n {\n \"routeType\": \"IP\",\n \"routeToAddress\": \"XXX.XXX.XX.XX\",\n \"routePort\": XX,\n \"id\": null,\n \"type\": \"route\"\n },\n {\n \"routeType\": \"PSTN\",\n \"routeToAddress\": \"1919XXXXXXX\",\n \"routePort\": null,\n \"id\": null,\n \"type\": \"route\"\n }\n ],\n \"usedByTimedRoutingGroups\": null,\n \"id\": XXX,\n \"type\": \"InRouteGroup\",\n \"default\": false\n }\n}"}],"_postman_id":"a9b4ad2b-1e8e-4ce1-b818-b73a81e7f3a7"},{"name":"Delete Existing Profile","event":[{"listen":"test","script":{"id":"0f8f53fb-86d6-4334-899d-b8e6b43af21e","type":"text/javascript","exec":[""]}}],"id":"221c20b3-8746-4c74-863d-06dd0db45d6a","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/caller_id/{{cnamout_profile_id}}","description":"

Use this to delete an existing CNAM out profile. You will not be permitted to delete an entry if there are any DIDs using it.

\n","urlObject":{"path":["account","{{account_id}}","caller_id","{{cnamout_profile_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"221c20b3-8746-4c74-863d-06dd0db45d6a"},{"name":"Update Existing Inbound Profile","event":[{"listen":"test","script":{"id":"6e09344f-07de-4f80-9634-3c166793ec56","type":"text/javascript","exec":[""]}}],"id":"b2334d63-b7b7-41de-8357-0b1abc599376","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":"{\n \"profile\": {\n \"subType\": \"static\",\n \"name\": \"Postman Updated Test Profile\",\n \"inboundRoutes\": [\n {\n \"routeType\": \"IP\",\n \"routeToAddress\": \"{{route_to_ip2}}\",\n \"routePort\": \"{{route_port2}}\",\n \"type\": \"route\"\n },\n {\n \"routeType\": \"PSTN\",\n \"routeToAddress\": \"{{route_to_pstn2}}\",\n \"routePort\": \"{{route_port2}}\",\n \"type\": \"route\"\n }\n ],\n \"usedByTimedRoutingGroups\": [],\n \"id\": \"{{route_profile_id}}\",\n \"type\": \"InRouteGroup\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/staticinrouteprofile/{{route_profile_id}}","description":"

Use this to update an existing inbound routing profile.

\n","urlObject":{"path":["account","{{account_id}}","staticinrouteprofile","{{route_profile_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"2063c60e-e930-4f7b-8273-92707eb2b685","name":"Update Existing Inbound Profile","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":"{\n \"profile\": {\n \"subType\": \"static\",\n \"name\": \"Postman Updated Test Profile\",\n \"inboundRoutes\": [\n {\n \"routeType\": \"IP\",\n \"routeToAddress\": \"{{route_to_ip2}}\",\n \"routePort\": \"{{route_port2}}\",\n \"type\": \"route\"\n },\n {\n \"routeType\": \"PSTN\",\n \"routeToAddress\": \"{{route_to_pstn2}}\",\n \"routePort\": \"{{route_port2}}\",\n \"type\": \"route\"\n }\n ],\n \"usedByTimedRoutingGroups\": [],\n \"id\": \"{{route_profile_id}}\",\n \"type\": \"InRouteGroup\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/staticinrouteprofile/{{route_profile_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"profile\": {\n \"subType\": \"static\",\n \"name\": \"Test Profile\",\n \"inboundRoutes\": [\n {\n \"routeType\": \"IP\",\n \"routeToAddress\": \"XXX.XXX.XX.XX\",\n \"routePort\": XX,\n \"type\": \"route\"\n },\n {\n \"routeType\": \"PSTN\",\n \"routeToAddress\": \"1919XXXXXXX\",\n \"routePort\": null,\n \"type\": \"route\"\n }\n ],\n \"usedByTimedRoutingGroups\": [],\n \"id\": XXX,\n \"type\": \"InRouteGroup\"\n }\n}"}],"_postman_id":"b2334d63-b7b7-41de-8357-0b1abc599376"},{"name":"Delete Existing Inbound Profile","event":[{"listen":"test","script":{"id":"703a8ea4-6a3b-4f10-888f-93a17a90ec05","type":"text/javascript","exec":["//tests[\"Status code is 200\"] = responseCode.code === 200;","//var jsonData = JSON.parse(responseBody);",""]}}],"id":"e6d7b50b-9dec-401b-9257-2d9ffb0a0481","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic Y2hvc2tpbnM6ODg0NDM1MjQ0YWVhYjc2NTU5ZTQzYjcwNTJjMzVhN2M1OGYwZTk3Mw=="}],"url":"https://api.thinq.com/account/{{account_id}}/staticinrouteprofile/{{route_profile_id}}","description":"

Use this to delete an existing inbound routing profile.

Get all timed profiles for an account.

\n","urlObject":{"path":["account","{{account_id}}","timedinrouteprofile"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa0fa216-b035-403a-bffc-6aff68f48ff6"},{"name":"Edit Timed Routing Profile","id":"ad7d1329-6038-40c5-b862-79a31749a04a","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"profile\": {\n \"subType\": \"timed\",\n \"name\": \"DeleteMeNEW33\",\n \"timezone\": \"-4\",\n \"routingGroupsByTime\": {\n \"00000000T000000|00000000T040000\": {\n \"endTime\": \"04:00\",\n \"id\": 354,\n \"inboundRoutes\": null,\n \"name\": \"first\",\n \"startTime\": \"00:00\",\n \"subType\": \"Static\",\n \"type\": \"InRouteGroup\",\n \"usedByTimedRoutingGroups\": null,\n \"startTime_in_minutes\": 0,\n \"endTime_in_minutes\": 240,\n \"textTime\": \"00000000T000000|00000000T040000\"\n },\n \"00000000T040000|00000000T120000\": {\n \"endTime\": \"12:00\",\n \"id\": 46,\n \"inboundRoutes\": null,\n \"name\": \"second\",\n \"startTime\": \"04:00\",\n \"subType\": \"Static\",\n \"type\": \"InRouteGroup\",\n \"usedByTimedRoutingGroups\": null,\n \"startTime_in_minutes\": 240,\n \"endTime_in_minutes\": 720,\n \"textTime\": \"00000000T040000|00000000T120000\"\n },\n \"00000000T120000|00000000T000000\": {\n \"endTime\": \"00:00\",\n \"id\": 246,\n \"inboundRoutes\": null,\n \"name\": \"third\",\n \"startTime\": \"12:00\",\n \"subType\": \"Static\",\n \"type\": \"InRouteGroup\",\n \"usedByTimedRoutingGroups\": null,\n \"startTime_in_minutes\": 720,\n \"endTime_in_minutes\": 0,\n \"textTime\": \"00000000T120000|00000000T000000\"\n }\n },\n \"type\": \"InRouteGroup\",\n \"default\": false\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/timedinrouteprofile/{{timed_routing_profile_id}}","description":"

Edit a timed profile for an account.

\n","urlObject":{"path":["account","{{account_id}}","timedinrouteprofile","{{timed_routing_profile_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad7d1329-6038-40c5-b862-79a31749a04a"},{"name":"Delete Timed Routing Profile","id":"54c81f59-9c61-4555-8cd7-783eef912128","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"search\": { \n \"npanxx\": 919\n}}"},"url":"https://api.thinq.com/account/{{account_id}}/timedinrouteprofile/{{timed_routing_profile_id}}","description":"

Delete a specific timed profile for an account.

\n","urlObject":{"path":["account","{{account_id}}","timedinrouteprofile","{{timed_routing_profile_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"54c81f59-9c61-4555-8cd7-783eef912128"},{"name":"Assign inbound routing profiles","id":"29d80761-2738-4a81-a350-a2ac66356edd","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"routing\":[ {\"did\":{{testing_did}},\"route_id\":{{inbound_routing_profile_id}} } ]}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/routing","description":"

Assign inbound routing profiles to DIDs

\n","urlObject":{"path":["account","{{account_id}}","origination","did","routing"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"212548c5-4634-40bd-a489-937b0a711359","name":"PUT: Assign inbound routing profiles","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"routing\":[ {\"did\":{{testing_did}},\"route_id\":{{inbound_routing_profile_id}} } ]}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/routing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true","name":"Access-Control-Allow-Credentials","description":"Indicates whether or not the response to the request can be exposed when the credentials flag is true. When used as part of a response to a preflight request, this indicates whether or not the actual request can be made using credentials."},{"key":"Access-Control-Allow-Headers","value":"origin, x-requested-with, content-type, Authorization","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"47","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 10 Apr 2018 19:05:02 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache/2.2.31 (Unix) mod_wsgi/3.5 Python/2.7.13 PHP/5.5.38 mod_ssl/2.2.31 OpenSSL/1.0.2j DAV/2 mod_fastcgi/2.4.6 mod_perl/2.0.9 Perl/v5.24.0","name":"Server","description":"A name for the server"},{"key":"X-Powered-By","value":"PHP/5.5.38","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"routing\":[{\"did\":4193338258,\"route_id\":246}]}"}],"_postman_id":"29d80761-2738-4a81-a350-a2ac66356edd"},{"name":"Retrieve inbound routing profiles by account","id":"266cff02-2769-408c-ba6a-e12cea513096","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"routing\":[{\"did\":9193456999,\"route_id\":303},{\"did\":9193456789,\"route_id\":409}]}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/routing","description":"

Retrieve all routing profiles for an account

\n","urlObject":{"path":["account","{{account_id}}","origination","did","routing"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"7553559a-86bb-49d0-bb65-8e9c2031ad16","name":"GET: Retrieve inbound routing profiles by account","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"routing\":[{\"did\":9193456999,\"route_id\":303},{\"did\":9193456789,\"route_id\":409}]}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/routing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true","name":"Access-Control-Allow-Credentials","description":"Indicates whether or not the response to the request can be exposed when the credentials flag is true. When used as part of a response to a preflight request, this indicates whether or not the actual request can be made using credentials."},{"key":"Access-Control-Allow-Headers","value":"origin, x-requested-with, content-type, Authorization","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 10 Apr 2018 19:02:50 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache/2.2.31 (Unix) mod_wsgi/3.5 Python/2.7.13 PHP/5.5.38 mod_ssl/2.2.31 OpenSSL/1.0.2j DAV/2 mod_fastcgi/2.4.6 mod_perl/2.0.9 Perl/v5.24.0","name":"Server","description":"A name for the server"},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Powered-By","value":"PHP/5.5.38","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\n \"total_rows\": 3,\n \"has_next_page\": false,\n \"page\": 1,\n \"rows_per_page\": 3,\n \"rows\": [\n {\n \"did\": 3524140518,\n \"route_id\": 46\n },\n {\n \"did\": 3524140519,\n \"route_id\": 46\n },\n {\n \"did\": 3524140520,\n \"route_id\": 46\n }\n ]\n}"}],"_postman_id":"266cff02-2769-408c-ba6a-e12cea513096"},{"name":"Retrieve inbound routing profile for single DID","id":"9d55a84b-7139-4f2a-a3dc-329ae701fa97","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"routing\":[{\"did\":9193456999,\"route_id\":303},{\"did\":9193456789,\"route_id\":409}]}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/routing/{{testing_did}}","description":"

Retrieve the assigned inbound routing profile for a DID.

\n","urlObject":{"path":["account","{{account_id}}","origination","did","routing","{{testing_did}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"6efad9f4-4c32-421c-914b-1455b56da1e5","name":"GET: Retrieve inbound routing profile for single DID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"routing\":[{\"did\":9193456999,\"route_id\":303},{\"did\":9193456789,\"route_id\":409}]}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/routing/{{testing_did}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true","name":"Access-Control-Allow-Credentials","description":"Indicates whether or not the response to the request can be exposed when the credentials flag is true. When used as part of a response to a preflight request, this indicates whether or not the actual request can be made using credentials."},{"key":"Access-Control-Allow-Headers","value":"origin, x-requested-with, content-type, Authorization","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"47","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 10 Apr 2018 19:05:21 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache/2.2.31 (Unix) mod_wsgi/3.5 Python/2.7.13 PHP/5.5.38 mod_ssl/2.2.31 OpenSSL/1.0.2j DAV/2 mod_fastcgi/2.4.6 mod_perl/2.0.9 Perl/v5.24.0","name":"Server","description":"A name for the server"},{"key":"X-Powered-By","value":"PHP/5.5.38","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"routing\":{\"did\":\"4193338258\",\"route_id\":246}}"}],"_postman_id":"9d55a84b-7139-4f2a-a3dc-329ae701fa97"},{"name":"Delete inbound routing profile for single DID","id":"f0b75914-794b-41f5-b433-6deb84ac4f8a","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"routing\":[{\"did\":9193456999,\"route_id\":303},{\"did\":9193456789,\"route_id\":409}]}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/routing/{{testing_did}}","description":"

Delete the assigned inbound routing profile for a DID.

\n","urlObject":{"path":["account","{{account_id}}","origination","did","routing","{{testing_did}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"a42a4484-e032-4c88-8940-67d6adba325e","name":"DELETE: Delete inbound routing profile for single DID","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"routing\":[{\"did\":9193456999,\"route_id\":303},{\"did\":9193456789,\"route_id\":409}]}"},"url":"https://api.thinq.com/account/{{account_id}}/origination/did/routing/{{testing_did}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true","name":"Access-Control-Allow-Credentials","description":"Indicates whether or not the response to the request can be exposed when the credentials flag is true. When used as part of a response to a preflight request, this indicates whether or not the actual request can be made using credentials."},{"key":"Access-Control-Allow-Headers","value":"origin, x-requested-with, content-type, Authorization","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Methods","value":"PUT, GET, POST, DELETE, OPTIONS","name":"Access-Control-Allow-Methods","description":"Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request."},{"key":"Connection","value":"Keep-Alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"4","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 10 Apr 2018 19:05:47 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Keep-Alive","value":"timeout=5, max=100","name":"Keep-Alive","description":"Custom header"},{"key":"Server","value":"Apache/2.2.31 (Unix) mod_wsgi/3.5 Python/2.7.13 PHP/5.5.38 mod_ssl/2.2.31 OpenSSL/1.0.2j DAV/2 mod_fastcgi/2.4.6 mod_perl/2.0.9 Perl/v5.24.0","name":"Server","description":"A name for the server"},{"key":"X-Powered-By","value":"PHP/5.5.38","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"null"}],"_postman_id":"f0b75914-794b-41f5-b433-6deb84ac4f8a"}],"id":"81452e5a-9e4d-42da-b72a-fdd14190e97f","_postman_id":"81452e5a-9e4d-42da-b72a-fdd14190e97f","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"CDR download","item":[{"name":"Migrating from FTP downloads","item":[],"id":"3dec81fa-6057-4b86-9d47-d8984e2928f7","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Action	FTP commands	HTTP request
List years with available CDRs	`ls`	`GET https://api.thinq.com/inbound/cdrs/download` Documentation
List months with available CDRs	`cd {{year}}` (Example: `cd 2014`) `ls` (retrieves directories, each one being a month)	`GET https://api.thinq.com/inbound/cdrs/download/{{year}}` (Example: `GET https://api.thinq.com/inbound/cdrs/download/2014`) Documentation
List days with available CDRs	`cd {{month}}` (Example: `cd 10`) `ls` (retrieves the filenames, each one being a day)	`GET https://api.thinq.com/inbound/cdrs/download/{{year}}/{{month}}/{{day}}` (Example: `GET https://api.thinq.com/inbound/cdrs/download/2014/10`) Documentation
Retrieve CDRs file	`get {{filename}}`(Example: `get 2014-10-21_cdr.zip`)	`GET https://api.thinq.com/inbound/cdrs/download/{{year}}/{{month}}/{{day}})` (Example: `GET https://api.thinq.com/inbound/cdrs/download/2014/10/21`) Documentation

","_postman_id":"3dec81fa-6057-4b86-9d47-d8984e2928f7","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Get list of available years","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"20cfa6b6-732a-4dba-8cef-01932464d3bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/inbound/cdrs/download","description":"

Provides a list of all years with at least one day of CDRs available for download.

\n","urlObject":{"path":["inbound","cdrs","download"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"0998bd50-5f8e-441b-ae35-5a707357a6dd","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/inbound/cdrs/download"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\"2021\",\"2022\",\"2023\",\"2024\"]"}],"_postman_id":"20cfa6b6-732a-4dba-8cef-01932464d3bb"},{"name":"Get list of available months","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"8afade4c-adac-4bd0-96bd-93739e177788","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/inbound/cdrs/download/{{year}}","description":"

Provides a list of all months within the given year with at least one day of CDRs available for download.

\n","urlObject":{"path":["inbound","cdrs","download","{{year}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"850c70bd-cb69-476e-b378-edbe29238335","name":"Example for a given year","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/inbound/cdrs/download/{{year}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\"01\",\"02\",\"03\",\"04\",\"06\",\"07\",\"08\",\"09\",\"10\",\"11\",\"12\"]"}],"_postman_id":"8afade4c-adac-4bd0-96bd-93739e177788"},{"name":"Get list of available days","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"b676af4a-645e-4030-9df8-5cad6ae179a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/inbound/cdrs/download/{{year}}/{{month}}","description":"

Provides a list of all days within the given year and month with at least one day of CDRs available for download.

\n","urlObject":{"path":["inbound","cdrs","download","{{year}}","{{month}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"5889ef4a-3466-4f7d-b098-c9a4ece268c7","name":"Example for a given year and month","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/inbound/cdrs/download/{{year}}/{{month}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\"06\",\"07\",\"08\",\"11\",\"13\",\"20\",\"21\",\"22\",\"25\"]"}],"_postman_id":"b676af4a-645e-4030-9df8-5cad6ae179a0"},{"name":"Get list of available days","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"5a9ecc09-9ba5-413b-8871-dc16fcd12328","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/inbound/cdrs/download/{{year}}/{{month}}","description":"

Provides a list of all days within the given year and month with at least one day of CDRs available for download.

\n","urlObject":{"path":["inbound","cdrs","download","{{year}}","{{month}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"98750a2b-0fb8-42ed-aaf5-7e4e3a3399e5","name":"Example for a given year and month","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/inbound/cdrs/download/{{year}}/{{month}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\"06\",\"07\",\"08\",\"11\",\"13\",\"20\",\"21\",\"22\",\"25\"]"}],"_postman_id":"5a9ecc09-9ba5-413b-8871-dc16fcd12328"},{"name":"Download CDRs for a given date","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"66ed04ad-015b-4aa5-991d-1d571813c590","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/inbound/cdrs/download/{{year}}/{{month}}/{{day}}/","description":"

\n","urlObject":{"path":["inbound","cdrs","download","{{year}}","{{month}}","{{day}}",""],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"bdb8071f-e529-4366-b8cb-8a53711e5494","name":"Example for a given year and month","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/inbound/cdrs/download/{{year}}/{{month}}/{{day}}"},"status":"Found","code":302,"_postman_previewlanguage":"Text","header":[{"key":"Location","value":"https://storage.googleapis.com/mdrs/123/2015/10/2015-10-21_cdr_123.csv.zip?signature=abc","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"66ed04ad-015b-4aa5-991d-1d571813c590"}],"id":"8d708958-a726-462d-b974-12a3545854e0","description":"

This group of resources is intended for discovering every date with available CDRs and providing a download link for a GZipped CSV file containing all CDRs for each date.

\n","_postman_id":"8d708958-a726-462d-b974-12a3545854e0","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}}],"id":"c625b42d-06a8-4f1e-a3b9-c4d8c9391050","description":"

These are the calls for our Origination based products.

\n\n

Activating DIDs - Step-by-Step

\n\n

Perform an Availability Search (Regular DIDs):
curl --silent --request GET -H \"Content-Type: application/json\" --url 'https://api.thinq.com/inbound/get-numbers?searchType=domestic&searchBy={{searchBy}}&quantityNeeded={{quantityNeeded}}&npa={{npa}}&nxx={{nxx}}&state={{state}}&rateCenter={rateCenter}}'Authorization: Basic \"{{auth string}}\"'

\n\n

Perform an Availability Search (Tollfree DIDs):
curl --silent --request GET -H \"Content-Type: application/json\" --url 'https://api.thinq.com/inbound/get-numbers?searchType=tollfree&searchBy=&quantityNeeded={{quantityNeeded}}&npa={{npa}}&nxx=&state=&rateCenter=' --header 'Authorization: Basic \"{{auth string}}\"'

\n\n

Create an Order with an Available Number:
curl --silent --request POST -H \"Content-Type: application/json\" --url 'https://api.thinq.com/account/{{account_id}}/origination/order/create' --header 'Authorization: Basic \"{{auth string}}\"' -d '{\"order\":{\"tns\":[{\"route_id\":\"\",\"did\":\"{{did}}\",\"caller_id\":null,\"account_location_id\":null,\"tollfree_prefix\":null,\"features\":{\"cnam\": false,\"sms\": true,\"e911\": false}}],\"blocks\":[]}}'

\n\n

Create Order Sample Response (returns the order id you'll need below)
{\"cooldown\":1800,\"account_id\":\"{{account_id}}\",\"user_id\":\"rreid\",\"status\":\"created\",\"tns\":[{\"account_location_id\":null,\"caller_id\":null,\"sms_routing_profile_id\":null,\"features\":{\"cnam\":false,\"sms\":true,\"e911\":false},\"did\":\"{{did}}\"}],\"blocks\":null,\"created\":1533580830,\"completed\":null,\"invoice_id\":null,\"invoice_url\":null,\"sub_type\":\"did_order\",\"taxExemption\":null,\"completion_started\":null,\"id\":{{order_id}},\"type\":\"origination_order\"}

\n\n

Complete the Order
curl --silent --request POST -H \"Content-Type: application/json\" --url 'https://api.thinq.com/account/{{account_id}}/origination/order/complete/{{order_id}}' --header 'Authorization: Basic \"{{auth string}}\"'

\n\n

Complete Order Sample Response
{\"cooldown\":1533582630,\"account_id\":\"{{account_id}}\",\"user_id\":\"rreid\",\"status\":\"processing\",\"tns\":[{\"account_location_id\":null,\"caller_id\":null,\"sms_routing_profile_id\":null,\"features\":{\"cnam\":false,\"sms\":true,\"e911\":false},\"did\":\"{{did}}\"}],\"blocks\":[],\"sessions\":0,\"created\":1533580830,\"completed\":null,\"invoice_id\":null,\"invoice_url\":null,\"sub_type\":\"did_order\",\"appliedChangeLog\":null,\"taxExemption\":false,\"completion_started\":1533580860,\"id\":{{order_id}},\"type\":\"origination_order\"}

","event":[{"listen":"prerequest","script":{"id":"3b270c07-62e9-4db5-bb3d-def6769ba52a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"32161a72-6d74-4ee7-9331-1d28abf4a93f","type":"text/javascript","exec":[""]}}],"_postman_id":"c625b42d-06a8-4f1e-a3b9-c4d8c9391050","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Messaging","item":[{"name":"NEW - Send Messages","item":[{"name":"Send SMS","item":[{"name":"Send SMS","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"6547dc37-07a1-4a2a-a0d9-44b1ec17e8cd","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"SMS\",\n \"from\":\"9198900000\",\n \"to\":\"2125551234\",\n \"content\":{\n \"text\":\"Text Message Body\"\n }\n}"},"url":"https://api.thinq.com/messaging/send","description":"

You can use the token created in the Configure Send Token section to use this resource.

You can use 10DLC, TF or Short Codes as the destination number or you can send a message to multiple destination numbers.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

key	type	description	required
`channel`	string	`SMS`	yes
`from`	string	Sender name.	yes
`to`	string/array	Destination number/numbers.	yes
`content`	object	Message content.	yes, if `templateName` not provided
`├ text`	string	Message text.	yes
`templateName`	string	Message template.	yes, if `content` not provided

","urlObject":{"path":["messaging","send"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"04757479-5db0-4679-a8d9-f4af170e986b","name":"Sending SMS","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"SMS\",\n \"from\":\"9198900000\",\n \"to\":[\"2125551234\", \"2125551235\"],\n \"content\":{\n \"text\":\"Text Message Body\"\n }\n}"},"url":"https://api.thinq.com/messaging/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Message sent\",\n \"data\": {\n \"batchId\": \"afac997f-9fcd-4cde-9ca0-484a0e8bc5eq\",\n \"results\": [\n {\n \"messageId\": \"92347179-2457-427e-b293-a4d08842638c\",\n \"to\": \"2125551234\",\n \"status\": \"SENT\"\n },\n {\n \"messageId\": \"92347179-2457-427e-b293-a4d08848235a\",\n \"to\": \"2125551235\",\n \"status\": \"SENT\"\n }\n ]\n }\n}"}],"_postman_id":"6547dc37-07a1-4a2a-a0d9-44b1ec17e8cd"}],"id":"e2b3c52f-28e9-400d-8b1c-5852b94c486f","_postman_id":"e2b3c52f-28e9-400d-8b1c-5852b94c486f","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Send MMS","item":[{"name":"Send MMS","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"d18ebaaf-7312-4954-b0e0-b1744b3c08e1","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"MMS\",\n \"from\":\"9198900000\",\n \"to\":\"2125551234\",\n \"content\":{\n \"text\":\"Text Message Body\",\n \"file\": \"http://yoururl.com/remote_file.jpg\"\n }\n}"},"url":"https://api.thinq.com/messaging/send","description":"

You can use the token created in the Configure Send Token section to use this resource.

You can use 10DLC, TF or Short Codes as the destination number or you can send a message to multiple destination numbers.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

key	type	description	required
`channel`	string	`MMS`	yes
`from`	string	Sender name.	yes
`to`	string/array	Destination number/numbers.	yes
`content`	object	Message content.	yes, if `templateName` not provided
`├ text`	string	Message text.	no
`├ file`	string	URL of the given resource or the base64 encoded binary content.The following content types are supported: image/jpeg, image/jpg, image/gif, image/png, audio/aac, audio/mp3, audio/mpeg, audio/mpg, audio/mp4, audio/mp4-latm, audio/3gpp, application/ogg, audio/ogg, video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm, application/pdf. Up to 5MB.	yes
`templateName`	string	Message template.	yes, if `content` not provided

","urlObject":{"path":["messaging","send"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"f5c53d59-b768-412c-a257-753cd13a86f4","name":"Sending MMS","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"MMS\",\n \"from\":\"9198900000\",\n \"to\":[\"2125551234\", \"2125551235\", \"2125551236\"],\n \"content\":{\n \"text\":\"Text Message Body\",\n \"file\":\"/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAAMgAAAADoAQAAQAAACwBAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDL/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAEsAMgDASIAAhEBAxEB/8QAGwAAAQUBAQAAAAAAAAAAAAAAAAEDBAUGAgf/xAAZAQEBAQEBAQAAAAAAAAAAAAAAAQIDBAX/2gAMAwEAAhADEAAAAfPwAAAAAAAAADv0GTzs9JpTIFnX28PNdyybWrt8aVFREFDNAdMgAAAD0rJaSee6IsmdZu7W1821jSXnm6nr8by25TQ01reS4SbtoU1lku66WIOEZQWR0kbq8tePTL2OjXh2qZE1OPWLxL4kh20K+9HDM5F1r2+YAUABUCwucsJ6Vb+PPSeqGHB599rwe51+IuNzuoPWbMRtRWX+0lZjV+X/AEvByBsAAAAAAAAABtTlPl/QDvoa7CDjtwi6Otmevy5KgVPVwAFAAAAAAAAAA13NzXfM96Jz3m9dNiv8tz7i18+13nf0vAgGqAAAAAAAAAAAHt+Q2bPn6YhZkbw+1rpXSNp4lv7fH5TXek5P08aI65UAAAAAAAAAAAPcovktvz1rY0y2xqDYZrO9Oe5689tdZ0k2klQ5ltHZ15FH9jza4Atau1AAAAAAAAPXJjWBzm7zyLaxIEO+eegkssGom4tTY2Gbsksa3vsyed9kjL5AbjK2wQAAAA9vbdSZzeW9NbPNDUZRVXjqk6VIRrp04RGy9t8lybLrM3KaMqOBvK+gSF8aT1fLGaNkG0RviTtvopBQzOV9Q5PMX9JlFlNdqMvccHPfXIcD51osh0bbnHaov+ukk4KMmtAQLC5BFsFQBFAF7XNZn01mXzWZoaqqKVoMmdtcKPtWe1KDTOUklpiqSPOkkdOXZ+2kwuO9i/5xsfT5bYVd807VVAAFBOOwytVvminbt3znipzstvmLalnSU5EmS0ZqzfN9eufl/Qbpr1dZrNhlKr1cPUDGazv55CoWKIogICLQy22IpCdI+sXvFz9dpKjaA+jlXBGM5vuq+X4Pa6J1mo06iVMPQsdc2Gi8379Pn9IWks+vF+PS4hbnPWFpx9EGFfMzpaPOWHfxYZi1rc9GGn+VZLsSum00jh3v5FHO49LEjvYqp3zLzCnc2Z6NqGu2M5bS+M13ppMak16P+zjpHc7adfNAq7GsThOe1jl2JlUmRMdnpNc5jdzOz8zh0vOq6Xz29yEqCoJx2JEZnR9Snfbhenlq38ZZduN9DJTlAkSQfIZVA0x06ctSGpofhd51ZTKd/j0vX6SXx3ZEdzNcTlVOOubIlVdVvTNWzYRfTyjjq7w3y8iMEoU7QZVtGdQTkHXoruekuRBf49LCTWP8tWfUR7GnkbAgTo9kSPN43mvdkJucL0uag+R//8QAJhAAAgICAgICAwEBAQEAAAAAAgMAAQQRBRIQEyAhFDAxQCIjJP/aAAgBAQABBQL/AB1A/o/z941ZFiccpS2cYg43hSqMwXrliQ+V19j/AD9/EY3dnJ5xY8VzZ1FcrislELBPFSyN4dRRnFNCCgwuqmpr9IqIoGJdz8QYWLdQccyYNBhYjmk53gGEu1cvlLiubUUVlodCATh4i7h4J1CSYy6uviGOw4GDcHFAZ66qdZrxhJ3fM5P38txWdkJg8v3pXJ4rZV0QkhReASZxeDAxljOuprxrxcEO5NYOHimdmf6gaxVq5jJCfjLqCNjKZUq5vzqalzEV9cxlex37bGa8dZsxlNqbnabqCHcsx9YeIV7L/BuUU/5udJdsGbK5hqsV8rle/J/dup2rxqdamvG7ilU1nI5P4uJ+/rWg3N7+WMvovkcr8rK/flY3pKa8dfFXMdfsby2V6Mb/AAGAsDIQSD141qf2dftK6QjNyLysn/CxYtBqbUepqComTHxjE7qrmRxOO6ZHFZKZr9/8hZSAjuQwmUtLGQMMBn0IrzcZtvto0GUs7j8NGRMjgzqMSxJfstxnMbjMrImPxiEQjFcbzA1CY9591xGVlBK5DDya/GaqvzPXdFRUYAwcjhVHMjj8jG/Xj4GPjRjQVG8xdwrJt77yxGrq7E6DZe3rFG1ZDywSsVR173oinqeJGQW7BxMuZHDPXCGwv55IuNTsdyyMxn453PbtdLo12RMsqCrojQQgBn7GKutUwOWYqUvDzq/+zHi8nHcUahT6yODq4/Fdj38iATp/FjpuMxF2yrKksbPZtdLE13bSh9JXfHlUkzL2oh6K1Z7sZYZGHyNfjZGPBzxEquiq6q6yOIxnR/FZKJf1cSonu8mAmL+JX1etyiFtdultLv1EFgwduuytVAAsUJEoyKiRVH7FYuSxEVyqHjeB0v8AKciLctwx+GjImRwh1OJwiTfjtP7K+oVAwcnhxuNSxF0yF/6XREiAtJmRtXKpQhS3lZsA4K6Fa3NJgESnDywgf42LlzebjwfsfHaf34/dQhBlZPDjcchiLH+F1iremXSGGV3iRArebO9yiulLSJ2biufkXrAycwy8ZWb0r9H3U/5KZPF9yZhmmMyLulYPsQTHex/UwpXqFrvewRAAo2OYjiQlDQ0xoJDM5Umz7usfNRlT+fPU14NYmLOLWNBk52MzM5FAB6xbd+xJf8XE8a5tqxwUMy+RVjx+U3JMQn0MPHJd43KsVFOW8fhr5WO5kcQBz64xqnY3IgvikAyq1DMVjltymD+FdwcMIWLY00WVcZj0UD2YrcbkVP8AGv1EAnS0rVUy+SVjTHY3MfkZRXdnBKAcqxZXggo6Zj2Mx+Rdj2jLVkV+pjQUOZy5MghZ3hD1x8gvWdnc7lAddWllHXnW4xFFLWxJYvLWMW0G188zk1Y1PyHZZrTFYYBTbpcZS3w8Up6GVBx2XFKFJb+NjVxmNAN2MWLygnKKi+DWgkMzlzbKAitSIdl3TW1vVtVyyupbClsKDRFYslF8jXRRmPqJy3Y14/IqdXtDWVyqkU57ss1Y0pVVQ5NY55KfZMatpuvp69HYyxnWYSaJgnBZBOb+OtxiauGmxl+2Cm7taaHz6ActLLxzX163cf8Ad35rIJV1cooJwWSilfG63PXU6VP5NzcttjK04UWaDso2WU7QPu/SJBdam5RQTgMgn+i6l1LuHf2jJ6Siq5TNwq3CVueiCvUH+FUuvFXKKCcFkov0EMYP3cFpLgZ0HMXc9q7ncJ7Al5Khm5cuvFXKKUUE4JzfzYG4YyxmvHa53Kdi8dpvxfirlXKKCcFkopub+BQ7l1L8dZ650lLmvG5dzc3KuVcopRSjlHO03NzcKEM6wgnSVU1NSh838alSpUqD8S+dT//EACMRAAICAQQCAgMAAAAAAAAAAAABAhEQAxIgMCExE0FAUXH/2gAIAQMBAT8B6Vzqz4mOLWKxZuLxQtFsWlFG1FGvL65UeRLg3Ssb3O+zWl9dK8+VmctqPbvphqbWKn5xrTt7eqkR1dqpDk374Xz98a/DvjfSoldcYnhEtNMlBroSxuZeGrJ6Q1XCiMB16y1wcEyel+imKLZHTIva6Y/EsWWJifDZYoVj+mpGmJ4sTExSE+MiSKPJWExMTFIvLQ0bTazZiyyLLLy8Vn//xAAhEQACAgICAgMBAAAAAAAAAAAAAQIRAxAgIRIwIjFBUP/aAAgBAgEBPwHnenzuh5YoU090UVtuiWeKHnkxzbLMEb750Se6ErdEI+K9N6swx/fS+unuEbZFUvTkx+SH0IwQr5P1dksXk+yMFH6/o37H0W/whmf6Kd+h6cb3GXiQyoT4t0XJi1Y1uORojkTEyyeZL6IK++MoDiVqyOUlkctQfXJxJQGuCIassvVDiSgOJW4sjIstHmtUUNEkNFFCLPKy9f/EAD8QAAECBAMDCwICCAcBAAAAAAEAAgMREiEiMVETQWEEECAjMDJCUnGBkUBiodEUJDNTY3LB8ENQVGCSseHx/9oACAEBAAY/Av8AJQBmhWJuXdkVgKu1XBH0m2dk3JNhwjJ+ZXWww7iLLvUH7gpghw4K7FhMla6u3tMlfnDZZq/dYE6I7M882OLTwVyHj7l1kNzfS6wRWnhNYmgrvS9bq1/RXHysujkr82XQ2p3ZIcnacru7DBFdLQ3QbymCHic7Lv0H7grEELuy9OawWJZdMNG9F3lFvVFzszn2c2Pc30KxyiDislhV+w2h9lsWnCzP17ax59FqForc4aN6Lhnk31Uz9HcLC5XCwlVu7xVLTgZYfTgUo0951m/Q5dOZzKJHcFm/QTHdV+lwC2bTjiW9voS12Skctx5rq3NJX9SnRN2Q9PoqSpHnwtKnEGSkVNvVu+1TA2jdW/QaLFGYPdUmJPiArC2pU3YitwapMij80DChtdqCVSZsf5X25ushieozU4D6uDlTEYWnj2ty53qVOnZt1cpnrHauWJwaupZPiVMxazxMpeyxsDjrkptihzdHn+iojtp/m/uyq5NGw+V9x8qnlMN0E65tU2mY4Kl7Q4aFTguoOmYU3Mm3zNuOzwMmdSsbvbeupZJus7qqovP4qVNR/FDZGo8cwpxW/wDLvohr76HvFUuYCR5xiU4fKKHHMOVHKIch/e5bTkkUwyb4cvhdfCqb54f5KcN4cjNs26hTpk7VinC6wfipOBB49hKA8MdrJVR8Ez3iZzQD2H+bxFCiTp7siqHnae8pKpk4kvCbS/NYxOVsVpe66jL7sz7qmLYS7m+X9FSHFujdfdNZRkcLC2aDtsYcQm++Xumtis2jf3mU0IsPA85EYXL/AFDPhyl3InldY80osMO9VPk75fa5dbDI47unJwBHFT5NJjuO/wDJDbDZzy3obSE10tc/lTZJ4Fr2kqHdZLXw+iLmTcRufl7arG0nWvIKUE0WvPf7oF5pa4dweIKRqhg7m3WzppbPJtwSq4rqYu4C/wD8Uqv0ganwqT2gOHm3e6nyeNWzyRPzVPKGOgu45KYMxwUjcKbBs3fbl8KYbW3VvO2G3Nx6EnAEcUTCz3NccKlGaRpohtWCJ65rAQ7RptJGE/rODsm+idRMvHhebfKppdPQiyDYRof4nDL5QjVbNuVQ3rIwwcy1TgzDHDvjMj+ilHww9QL/APqqbGqaP8LVUcoh0fiFVyWK6EdM2r9ag288O4U4bw705ushieozU4D6h5XJ0WK2T8gDz2V+al7baFVQHUfaclKKwt/6XWNDwPb8V1Ui391lL80YcXEN8FSm5rtzNT6rZlpZowZf+ol7QyN4d/4IuF/4gKFRL4gziiy2kGcYjO3c9kTTtH6uGS/V+VYt8zK6EKM2bvE5q2sB1LvNDsViA5QzUWcgZEcDz2V+lS8AjQqqA6k+U5KUVhah+k9zdPveyp5NbWZxH3VU9m37lgc6ED5rqUMEVD9ofF6KcRha3e9qwS2Qy2ap5TZhyaO8V+1kNN5QhUSa3wuzQbDOx14oNjQ5w/OedzJGevZZIvhPk45g3CnGGzbwvNNY9gMNuU8/lGNDY553Md/d1S4GrySTdo+iIPAO6EIz323UFF72iZ3tQdD6x/Hw+ypkYricjmg+KSfsO5SAsFXEcAEWQcDNd5VlgdI6Hs5OAIRdCbi3VZLZxIZeqaaohHwgIRxHwuVJm06FYhQdUDZrD4hvQAF9d55qRjfopvM/6c0ypt+QqI4qbqpw3T7ScJ1HDchKBV/EciCyZG4qq7tA7dzTcZKUEUM1OZWOIF+0WAgrGJc1lW1SOF2hVuzkQJKTGgDhzUg1P0RixThbuUhl0KXifQmFJ+Jqwu9uzqe6QRZAs3VTKLd6Lee/TqbZUxvlTYZ9hIYn6Kbz7IKbz8LAJLFmsLprJZKpzvbp2U2kqmJYqYPQqeZBFkCzdVMqwmVdNVuhn2VlnMK5kV3wpMxOU3n2V+aUvdbVibzHoTO7s7LvFX6B8y2cTuoU5dLL6GxUn/KpN29K/wBFJ2Smwz4K9vqLFYhzZrNZrvfTZrNZ/wCzf//EACkQAQACAQMDAgYDAQAAAAAAAAEAESExQVFhcYEQkSAwobHB8NHh8UD/2gAIAQEAAT8h/wCPRFBipUfmiFaaJkJy1ZnQdr9ZYN/TWPJbHKc6lQIekFQ+lfNtw6zmL3Zn1o2JXg3LaYNfFUe860XVkAQPEyF32/qZGw7X9pTExxmYI/JKuaFGoajRhzNKhLyVTZiw9WOja36XOrBFUoDjQlQM8qkobx6D7Q6u+EBsR7B9ZYVO5X0f5jtMdBU1xVz8ALoRDDitc2i4aCKcRpG4VJwi3FPc7Hx2lF3Ap9ZTjBZ1k6SnMzaqX7mY2TK0XLqVNUZprmmlgRQV6KjFQRNUKbVahzDfW9r5Vy8I7EwvZNPuQB98B0JDYFQXRlpZMMYfQzA1xFD94PnAYWHM11LIHUVTWJ2InWAVlMdZdP8ALCaMgqhGS1yvzrlxXiXqdSpwD1j0/Rmq6cks34Wf5RZd/WY7vzzeY7UG9/T4JjpmZgE1ENVOINhXj+sW/n5DrNe6nWFGlS3ZgrvDvL5iHNTY7O9CXH+yc/8ABr/fR4jkrVzFwMZxO+aQN5XXnMzYAU6Q/wDAQFvaUkt+SdLMJUXeV9IV3wWQvibU4v4iy6Xj/hDjEdDh+keeN5jzJhppGqU9JhFMi4AgI6jLcFt9HtLUY/rUUNOE+e0M0OrPtfZf4tk4m63bRv8ACE6JeCbhihcHYzpYmWuk7Z9W/uXB232UWBj2n3nbCzX5qOW6rKRl/wBwhIbx+nYgWIrRa+kbqjnNT7TE85P0niCDzLX8m/mUStxMHu9ogotFOL+8VFrWN7eoh3EDJ5IXImirnTTLct1c/wD0JbLiGPlZAO7sGURBdy7G8cwKVe39ZeHJ39u/iF1qG+g7v8x3rwXSnTbzMJAm3RyderGrHYPgNmVRZCi23eCcrK1Tvs/SZ6astXfXo7QQdKan3ekdvvX94qAONyKXC5XzBUirifJpLVDjMeyPSvUFPyEvNa19Ok6HhknR3iBU9deTRlnMZjae5MqoGzc99/Mtpdpp8GfYQdfiSdPY2QhZKGMO1w9pkAmprXD90tFnjbcH8ppLGdQ/nxKh3sPcp9orQWMhfjEM3eydt52z8Z+ZzDZLN+fSvz6MnmW37ToynB+S8/GxatQYg91rAp0Xr4R6oLdl2dPeBIgq026u6Wq6cR2609pXQ+i6fk9/aaRaKAOIYUQ6P8HiF1QNNh78q7xmnisn4oUtax69Ov3jZD/L6c3+4iUp9D9R+ukE7Ct1Djn3jU42/gml0Q9niADnubfZJWEmisShAmoywQ37f0hCA+r7msCgiPX0MfQfAsedQWTIc3a/y/EBoz9BIpqflXuPzcBjH1Rfhp7TMRV1ETflceNY1Ansz0a8zIWBTjT7BBcU4iroaiU43UW7dK18xy74F3ypDpc8us4dPvEDFqlBPaCVe0mfB08TViYb/wByAnGBs8TTr+8qViXV6D5PZDySxF2B99IujtYbvq7RcR1bidOnDFRFajZLS07vjuS6xvC/YwVDbZVRYyhcakLhWbmL5XbxO6cWOLjH0GOBkw/LJQEHK7JnL6uKd3aXrWg6OA3ggMmsLRXw13kdV7TUkqt9QcMYiJhUX0HaAnq2o7k0Ij/EiWLpe4ejW8douN6l9Pgq4Ohk4YjSNjEAd1an9Z0PB2fMsqD/ACuXvFXV1h+07RCy3069jfxHK4UuP+ZbBKNUH0V9YNEXaHn+pUqxMNHd3uNLsnAbbx3mhlOs8RssIylgr8nW+0ouwyRc+V1gca73PHPowi9qXKT5GusHQYg0i+El52Zln8QnOGqVuziE1DDMEV292I9YPw1bHwShBiU2HWtGJr1wsV77SnN0B/udQPrX8ksjSI/RLDXWphdXeGaGgG38RiB7stwph/RUsK7SCfRZibvjIPQmatRIMo1lWXtCVucFWeGYoUCH5w4kxvsy3HfhV/zF9pxjyRr0l2fQS4gCrnuM00hrTwnB3naHG3ZEXMA7KlhkSFDQvIgU/QazT1q4fEAJyUx5tVzqirN5bnbiB0JnVPMxeRqLIE0ATGIj8KbkLVlekBofaWVHiZ//AGRL1gV6ox34dNmZHJlXyhB8lQotRI64eE0Iag4W04kpsjJ6hlyvoobsoIHqwEj2XxDF2nnWEUr5ay4fIYjEe7M8PesyUV5hbkloXYxcC3m7hMI19K9GiZwMy4KjciQayZCHrL+JYwc40UJTbYTLZC3eCLLxFG0oNYrmawa0CLpwCDuzMnWyGE1leiw2khNseMNKfu8OpJL9Vhw5jFvS5szsXrH6JpNAUjpGvN4l1TJLk0ZZy4ndNRLL95ZBv1YwbSKrgyWHZgDyMc76kYJx1LDa22E0WMWIld71gqZL1qWl4grJjmkT4CAJ6YsLy/SvRomgxa7kGjB3l6ygAwx6Zud8YnblFw4wQmvhzElYjG339Xz+lZF6VH0GHjiGhMyWjWKVRMbZ2i2CsuiSFcRzFtTFDPoj01G86sFgy/R+C2V6SjX0ljUgGoI0AtOBB2QN6Q9JAa/Tpl16PXlfpXS/iSXSmDGsk2bJi7qGmM6OU7Zrg9FH0NPgbrlsCy5fqsfQU+kxklO6dfFtXLWXhDkgl5+FY6kt9S4sWKiAsvgpmGZ/AhBGMMfkClZb1GMiXswJZLkp9FX4B+j6HwFRtxMNPR+AkT1PR//aAAwDAQACAAMAAAAQAAAAAAXzotaHDAEEO2yMyb2o2zClLKTexAAwl/Bfaq9T3gAAAAAwlX/vCxAAAAAAAuTQ/ZAAAAAAAA2OKoVEAAAAAAAGAA5SBWEAAAAArwgwAItxGAIAA0xcR+o0E9dI/OSwoxku4UI44FASJl9NGUjCIxF9JJDCUwLT20kFOjL4RgIsGNFkfAgqbW6Cd86a3a+TE/mXTGgNAnP+HF7YMEDjw1vGypSPmG/SzKgfV82M6ouMcBnxpAw//8QAHhEBAAIDAAMBAQAAAAAAAAAAAQARECExIDBBUXH/2gAIAQMBAT8Q8lqDm+QuCCzrEC4iUnIIxpLgnk7GMA4RijWBXhRgQJ8gYuGiiqvRqVKlXN0hXopBeAVitj0tu4yhSKHZqnyCemg2ywj30+YuAl+S/U+ZrBKwMG/Y4vBfasLljWaxcN5WoF8wVoYZObP743F/ItWwKlHIu9wYMWcj9+AmK/IqpdwQKwa6gjip2YpCWo5P2gfqclF/sscH8ymC9g3hIlQIuou05minwl+JCzLE1BcFKljG8PAGyFsOau4heIGkNIN5JZ4P/8QAHxEAAwADAAIDAQAAAAAAAAAAAAERECExIDBAQVFx/9oACAECAQE/EPJuCFvoNOhocZ4hA8MIxHTNSlTmaOkz9D2rx0RYNf2ahChqAhKXo3hROWVL005NLDFpC4elGrTRTRlPg1f0L6YwlTHEZTKXySXopb8B+FfpcFT8KUW8QZRlsy3AhoKXRS+FKMzYnoTSw3gY6IfhRPRRfoY0MNWFo7IsEMadZoB0CVEhGJYN44wmW0NS2aQSoiBPWYj+i3sYNWUORBVLJRFhbBAcCEOW0WJ+8bwrAoTge2DQTp1DdMKf/8QAKBABAAICAQQCAgIDAQEAAAAAAQARITFBUWFxgRCRocEwsSDR8OFA/9oACAEBAAE/EP5c/O/gjqLqzA8fJl/HUqOiCA2rF0LJKr6jT1Q/8VCC44X+1MwIPRzXhqdh5Mn7iXkcRKYl3VKHxEy/5STottGHrgWs4hwKO8yzLKvq0wkff/ILIMXDRq/NQ79dmI+SqfZLu8ccfRf4EdVFy5vaf6jVZ2/1GZcTk2dIFhy6jTcSv8K+KgtBYiXeUlQ0pjRi2bpGjIxR9y4oZ8d/tiCLdfBwej47MToWha/EoH/VteSmL2+zW/TT/cL/AOfGsz0wPj3CANw+xrh6YxQTY7vv+mPOgh/nH5mVJ2MffyaiFIvQIKqDyk4amna6pCwA9SghxglDVb1FB6ya28/qZelKn/hy+ukcrm/8RqAGHuPSVak/8TaKU+VvgVKPjE9IVN+ckFPfC/HZBLdYzfZj4V+A81FShvNXDy46pKwh2J4TxIHSPGADiDZoRvgdYW0fefUeSyx2rf8ADeKlqriGRvloYPZF+iHxVnlKkuh1F7761K2pvvDRR8QaGL8FxbMdekYW3gvbbM0z2hwv90V+Y7/kuAWniNxa+0wMHcgHp50lIH1lmO01dEiLCw12rtAOypyTVL0cspLLj5RRjobizHqNq5v+ZBk3FOoBwpziog4hQ39SZQCzPDLo6Z7GNUh9koLeArjoPLFuCxj/AJrKPEbvP8y8jfQhKtcYjhcE7LIst2pfdBRuFYSmJwAeyJUiJA3hn0P7mJlf50hD2EwVx0bMPMWcENi1KSwzHYlKaCSzY4XG5E8GQ/csFcfxRz7N+q/+C9APZaXRjXKhqAtXnqS6uaYZLHUY2qWBM8eZ0Lr9a0Q1EIqc8771FgL/APgBaXK47neJHd9A/wBxwtvcCtUwWwOqA6cdLFBNtjrF6h3XwC38TC3bowwV/fuJX/wA2VnFaZhLlDyusKNOzQIwU1Q3t7GKhbaMfeoTRiPJdTAyYAicjfE2Xly3zx9VFcwGZQ7vI/cVCopERH3Er+ZKX1gAfdQ+kzha/Q3G19Z4PhVD+oqZ3JgJ1L3Blwf81zKegJ2D1z6uO0XA13cw+LJnuN/qNWHeqvorr0YBVVxizj3AZmYKrwn7lXJt15+D7rzGQLorPB0+riV/JniHBYPi/wCo5m6opTqOX3DRHOguzg/MvtkIJIdNvUupfhqsWcac53GVQqMgbrq7XekdLKjroxS1R7O8FtqolQHfStNr1ABhQFFM9A6LXm44FcVIPAfkvzDNJ1nXb90zkOEP2Yit2MgP516idZ72vrR9yoOa/MJk9hKp66/xEgzxjvbg9HuV2+tDndvwJV3gKRjYaZ3iXq3X5Wvy9oqOwEaPUhbSGWV44ddGYpHbbQnlyW7MecpWZHTDdXc1qYv9LYlU00OQpCMgRQ5F5Fg8D9I2rADGjLeLbpPmZlw/RecgccagzVvY5+YlI92Gk8OSMSp549kWhrNJPY7HiKG/OnPLD6fUd/NLh6f8zcWZXpju6usfgWxYhmgt8moEprnmNYWBwN+emcjUHX5f9PeoBGWy+qStvtgRlphAHVjK8oSuFCZwABdDjPh3LyUWyVmzHgZRQAq2vgOE9DmOMYtq8X6sQqEIEXW7R48iu0ZS/WqKu2czfLWYwoSrS6iYY4cvOYgdiYOb2/fzEvU3FHpHHrH6Wg9qRF4oPXQmMjUP0AyepdS+M54H9kVlTRX0BiP+BsiwHx0Io7jBJFUIbwtR6GczEiBhb7FDPKPDKJJgV+gJj3KNajbXfQgn7X8TO1vO38nAvpCwr17eCukdFOtQhMdA2NALXfU2AlkUp5DvsAD+5ZtUgKbHNBrd30IjjfKLQFwdGcN9oU/C0ANay7OIqKIFfl0Tin0hjQuClxxn3wgrSkSw88V9MeIno2AUf1zqo8R9KBdSEV4YoPFDETuOJvYQRdu6wEbwjZgf8uYMYNIKT4RokLwHL6My4ztfqAl2hU9P9xGFdjF719M06Rij0nX6h5hAnEuo6OZ8UdiJ91AkPBax3T4gT2auYsrOAvB5lFsKEQy0o9GRDgQhAE1SAO1G4vHITd5OKumIMA+H9obOboQ81UJY5VrPZrtG4zruGDD4APWGLRDq/DqPuhXU1MI5lJeNOoGLUvHMzanUKF4R/JN6ZvWQF6I1mL1Ur3dyFHPaFnk4gilOe2Eje8lBep+zERFTYtfjZEW1TM/sNHb4UC3B1YblProI7adIYCbLfkE1APRPMT8myeX4M+YY0QFp7GP3EEIYZOwzn3NscV0Hirpd7WVPURsa1a06ZRHuNBeINh5HyRw9gR0m8Nu8qcvStbGnqt10gg1Ocl1s+ieoXibBwlCcVecXFCEMVxxfJ76imswjNhC3OrqLsnSVlVjix5xfEQNgFcc7W2fq4GIXNoPrfYRbbfonnl6ixAlQWcNYv4Q2xVtYzzDvK9eCWuFw0QKMY8fFRGCEwC7hCIhSNX3c4dWZR7OWHzSqXPiGPW5dCJVGYmFMD6EIKUpmHkFhO1HzDAQpSX5Nq708zjUdB6qYX0zXLLugEuplLH27iWMjPD8GxvplE3aoNK4dqcsUUKqKDLX9sblA01Z0X7D6lUrV3be0/oBxUtYaYGHsXBTZibXoqgJhRi/Ym9FdoBC+dVzCgFYk6wpu3xBooxXEG/m/iohoGE5E6M3nV0EvrTiGuCpq+ad281KxqGFPSmB3Ytig1Qdm13wSj6R62OEfU6BvVQNGlIPuO7ANroXFUq0sOvD+ZSEQ8MFc9HMCdfKyna1LvfqZQmWG3kz9qjKZCkegDMFuBXEHBx6QJLtvXo6vYhCfWyj/AEl1LM2qsLhf8p1iLBlw+LlyoiwClBSVBDhQyJ3m4f2de6GHvcTYO1g9wBl/3PYkv6ZcRTkL6cvuZMXX4ccCIC6N2l9116i8Bs4l52HuHqDRsHsZVAH0R3eHmfV8eI/a9V0XZ+5Zw283CuF338QZmOJSRFrCro79YWTS1MPURwT6m/gWhKcsA1KlSiIf+xsGGDQjsmXBVS/g2RHAGhZ68DzMCKGw9Q/7i0rLZ/2IdMFGDBHh9BnK9jmYEdNUP1G8qVTKmBAl7x9C/RnuqLMPEE0BObj4A6K3HcG7UJX9a2hezKZIHm4huYnyfLuVEzfPWc51QGL3TaEFinABq5UbWEsXdjnlr4D2PUTaeLOYvVZ3cybZrPulyIxklUzyy8lZupjGRsdiOH6I9zr9VD8JSppDf+Dv52hvItXcd4beD+pZFK72ZWILHvmIAWox1TESs/GXxeiBLBTVRLIwFMNBLgbQp8BZADyqgyoW1lMpdQb+Hcd/Bk0gOLusvCnDoiUMkCqJZDi6v3EL9ae/w8o6aUFpnJHuI0/rAIV6JiBRuHwZGAmSVZVDQkpaA5ThldeDoYDQtIwtLiu+IbnLVZe0vYeXB7dI6tblVrFDgbBISjVnQRZTDuEjB35jVHCY3LppQZY5w54gMWLWWEAgAZIY3KEuIfCiUkRWLe0YG0Zl8MZyYhkbbFUBbTwohEEKCwMTqpwNeiajjvKsF9ahq6ws1C6pdwrBkpEiDZVSv4JxBLeZauJeoVQrg8sMxChhBbOI2QDEGNowqH8wdRmPETqFRuv0WmciXbGwF7jCGwnF3MeDKpeaireO8dhqZGogV1EKAg2wQe0DwzKAZemI2MxyooLYDWYGrPbLElFgTmc6gVJG8PqGaI9CyGbunpGNXHj7uaYmWjivXmXCtjoRbt7jFmSXVtPSF8pUgkmG9jaRlzEEjnMSkU0MBQ3mAjmCV8IJUARVdowa8S5pAMrGmyHtoWYFGd2KG7EVb3g7RTYE7Sl5S1aMR1ggnOe4xCaLCat5gkzCxdyyNMY7+L+IIccRnY5YktpjpcqoXdCBCMjlzkJu7M2vQYlMsOiVzKlDuAczOUxaW/mCAshG7h8G4tQJmMArVxVqJbiOOI8dkNIfcox+WbU+4qyr5lzUt3HolZcafArmElFU1OOkMFsCmITlAhQ7I9KNwCp8ZSdIE2RV7g4Dv4sCUnwLl+RTMZK5Qk0EqQx+ZlkvWFgliXLIslv8A8RjTFXLNvkmLBE1EslJmdVEoZcUXE5x2woHSUSvgJ//2Q==\"\n }\n}"},"url":"https://api.thinq.com/messaging/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Message sent\",\n \"data\": {\n \"batchId\": \"afac997f-9fcd-4cde-9ca0-484a0e8bc5ed\",\n \"results\": [\n {\n \"messageId\": \"92347179-2457-427e-b293-a4d08842638c\",\n \"to\": \"2125551234\",\n \"status\": \"SENT\"\n },\n {\n \"messageId\": \"92347179-2457-427e-b293-a4d08848235a\",\n \"to\": \"2125551235\",\n \"status\": \"SENT\"\n },\n {\n \"messageId\": \"92347179-2457-427e-b293-a4d088626381\",\n \"to\": \"2125551236\",\n \"status\": \"SENT\"\n }\n ]\n }\n}"}],"_postman_id":"d18ebaaf-7312-4954-b0e0-b1744b3c08e1"}],"id":"6a91e735-7117-44e1-83fc-7744027d3814","_postman_id":"6a91e735-7117-44e1-83fc-7744027d3814","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Send RCS","item":[{"name":"Text","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"db59b67c-785d-4608-ad36-fe2dbb959a63","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"RCS\",\n \"from\":\"Sender Name\",\n \"to\":\"2125551234\",\n \"content\":{\n \"type\":\"TEXT\",\n \"text\":\"Text Message Body\",\n \"suggestions\":[\n {\n \"type\":\"REPLY|OPEN_URL|DIAL_PHONE|SHOW_LOCATION|REQUEST_LOCATION|CREATE_CALENDAR_EVENT\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n }\n}"},"url":"https://api.thinq.com/messaging/send","description":"

You can use the token created in the Configure Send Token section to use this resource.

You can use 10DLC, TF or Short Codes as the destination number.

key	type	description	required
`channel`	string	`RCS`	yes
`from`	string	Sender name.	yes
`to`	string	Destination number.	yes
`content`	object	Message content.	yes, if `templateName` not provided
`├ type`	string	Content type: `TEXT`	yes
`├ text`	string	Message text.	yes
`├ suggestions`	Array of objects [0..11] items	List of suggestions.	no
`│ ├ type`	string	Suggestion type: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `CREATE_CALENDAR_EVENT`	yes
`│ ├ text`	string	Suggestion text.	yes
`│ ├ postbackData`	string	Value which is going to be sent as a reply to a suggestion.	yes
`│ ├ url`	string	URL that will be opened on mobile phone when the suggestion is selected. Must be a valid URI as defined in RFC 3986. Not all URI formats will be supported on all networks.	yes, if suggestions type=`OPEN_URL`
`│ ├ application`	string	The application type to open the URL: `BROWSER` (default) or `WEBVIEW`	no
`│ ├ webviewViewMode`	string	Size of the webview window: `FULL` (full screen), `HALF` or `TALL` (three quarters)	yes, if application=`WEBVIEW`
`│ ├ phoneNumber`	string	Valid phone number.	yes, if suggestions type=`DIAL_PHONE`
`│ ├ latitude`	number [ -90 .. 90 ]	Latitude of the location.	yes, if suggestions type=`SHOW_LOCATION`
`│ ├ longitude`	number [ -180 .. 180 ]	Longitude of the location.	yes, if suggestions type=`SHOW_LOCATION`
`│ ├ label`	string	Label of the location.	no
`│ ├ title`	string	Event title.	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`│ ├ description`	string	Event description.	no
`│ ├ startTime`	string	The date and time when the event starts. It must be in the future and before endTime. The required format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (for example, 2030-03-03T15:00:00.000+01:00).	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`│ └ endTime`	string	The date and time when the event ends. It must be in the future and after startTime. The required format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (for example, 2030-03-03T17:00:00.000+01:00).	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`templateName`	string	Message template.	yes, if `content` not provided

","urlObject":{"path":["messaging","send"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"71195b34-1684-499f-b0de-d7f900bb91ee","name":"Sending RCS TEXT Messages","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"RCS\",\n \"from\":\"Sender name\",\n \"to\":\"2125551234\",\n \"content\":{\n \"type\":\"TEXT\",\n \"text\":\"Text Message Body\",\n \"suggestions\":[\n {\n \"type\":\"REPLY\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n }\n}"},"url":"https://api.thinq.com/messaging/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\":200,\n \"message\":\"Message sent\",\n \"data\":{\n \"guid\":\"0713ab1e-a78c-4f2e-97eb-7303da766afc\"\n }\n}"}],"_postman_id":"db59b67c-785d-4608-ad36-fe2dbb959a63"},{"name":"Media","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"4e1a6007-839b-4f62-b083-4d7025ec4488","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"RCS\",\n \"from\":\"Sender Name\",\n \"to\":\"2125551234\",\n \"content\":{\n \"type\":\"FILE\",\n \"file\":{\n \"url\":\"http://yoururl.com/remote_file.jpg\"\n },\n \"thumbnail\":{\n \"url\":\"http://yoururl.com/remote_thumbnail.jpg\"\n },\n \"suggestions\":[\n {\n \"type\":\"REPLY|OPEN_URL|DIAL_PHONE|SHOW_LOCATION|REQUEST_LOCATION|CREATE_CALENDAR_EVENT\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n }\n}"},"url":"https://api.thinq.com/messaging/send","description":"

You can use the token created in the Configure Send Token section to use this resource.

You can use 10DLC, TF or Short Codes as the destination number.

key	type	description	required
`channel`	string	`RCS`	yes
`from`	string	Sender name.	yes
`to`	string	Destination number.	yes
`content`	object	Message content.	yes, if `templateName` not provided
`├ type`	string	Content type: `FILE`	yes
`├ file`	object	Resource object describing the media.	yes
`│ └ url`	string	URL of the given resource. The following content types are supported: image/jpeg, image/jpg, image/gif, image/png, audio/aac, audio/mp3, audio/mpeg, audio/mpg, audio/mp4, audio/mp4-latm, audio/3gpp, application/ogg, audio/ogg, video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm, application/pdf. Up to 100 MB.	yes
`├ thumbnail`	object	Resource object describing the thumbnail of the card, applicable to video files only.	no
`│ └ url`	string	URL of the given resource.	no
`├ suggestions`	Array of objects [0..11] items	List of suggestions.	no
`│ ├ type`	string	Suggestion type: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `CREATE_CALENDAR_EVENT`	yes
`│ ├ text`	string	Suggestion text.	yes
`│ ├ postbackData`	string	Value which is going to be sent as a reply to a suggestion.	yes
`│ ├ url`	string	URL that will be opened on mobile phone when the suggestion is selected. Must be a valid URI as defined in RFC 3986. Not all URI formats will be supported on all networks.	yes, if suggestions type=`OPEN_URL`
`│ ├ application`	string	The application type to open the URL: `BROWSER` (default) or `WEBVIEW`	no
`│ ├ webviewViewMode`	string	Size of the webview window: `FULL` (full screen), `HALF` or `TALL` (three quarters)	yes, if application=`WEBVIEW`
`│ ├ phoneNumber`	string	Valid phone number.	yes, if suggestions type=`DIAL_PHONE`
`│ ├ latitude`	number [ -90 .. 90 ]	Latitude of the location.	yes, if suggestions type=`SHOW_LOCATION`
`│ ├ longitude`	number [ -180 .. 180 ]	Longitude of the location.	yes, if suggestions type=`SHOW_LOCATION`
`│ ├ label`	string	Label of the location.	no
`│ ├ title`	string	Event title.	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`│ ├ description`	string	Event description.	no
`│ ├ startTime`	string	The date and time when the event starts. It must be in the future and before endTime. The required format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (for example, 2030-03-03T15:00:00.000+01:00).	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`│ └ endTime`	string	The date and time when the event ends. It must be in the future and after startTime. The required format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (for example, 2030-03-03T17:00:00.000+01:00).	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`templateName`	string	Message template.	yes, if `content` not provided

","urlObject":{"path":["messaging","send"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"45d5afbd-bbd2-4b67-9b92-3a5ce7391c6b","name":"Sending RCS MEDIA Messages","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"RCS\",\n \"from\":\"Sender Name\",\n \"to\":\"2125551234\",\n \"content\":{\n \"type\":\"FILE\",\n \"file\":{\n \"url\":\"http://yoururl.com/remote_file.jpg\"\n },\n \"thumbnail\":{\n \"url\":\"http://yoururl.com/remote_thumbnail.jpg\"\n },\n \"suggestions\":[\n {\n \"type\":\"OPEN_URL\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\",\n \"url\":\"http://example.com\"\n }\n ]\n }\n}"},"url":"https://api.thinq.com/messaging/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\":200,\n \"message\":\"Message sent\",\n \"data\":{\n \"guid\":\"0713ab1e-a78c-4f2e-97eb-7303da766afc\"\n }\n}"}],"_postman_id":"4e1a6007-839b-4f62-b083-4d7025ec4488"},{"name":"Card","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"e3075676-60d8-4d2c-a2e0-b0dc0677fd33","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"RCS\",\n \"from\":\"Sender Name\",\n \"to\":\"2125551234\",\n \"content\":{\n \"type\":\"CARD\",\n \"orientation\":\"HORIZONTAL|VERTICAL\",\n \"alignment\":\"LEFT|RIGHT\",\n \"content\":{\n \"title\":\"Title of the card, displayed as bolded text.\",\n \"description\":\"Description of the card, displayed as regular text.\",\n \"media\":{\n \"file\":{\n \"url\":\"http://yoururl.com/remote_file.jpg\"\n },\n \"thumbnail\":{\n \"url\":\"http://yoururl.com/remote_thumbnail.jpg\"\n },\n \"height\":\"SHORT|MEDIUM|TALL\"\n },\n \"suggestions\":[\n {\n \"type\":\"REPLY|OPEN_URL|DIAL_PHONE|SHOW_LOCATION|REQUEST_LOCATION|CREATE_CALENDAR_EVENT\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n },\n \"suggestions\":[\n {\n \"type\":\"REPLY|OPEN_URL|DIAL_PHONE|SHOW_LOCATION|REQUEST_LOCATION|CREATE_CALENDAR_EVENT\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n }\n}"},"url":"https://api.thinq.com/messaging/send","description":"

You can use the token created in the Configure Send Token section to use this resource.

You can use 10DLC, TF or Short Codes as the destination number.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

key	type	description	required
`channel`	string	`RCS`	yes
`from`	string	Sender name.	yes
`to`	string	Destination number.	yes
`content`	object	Message content.	yes, if `templateName` not provided
`├ type`	string	Content type: `CARD`	yes
`├ orientation`	string	Orientation type: `HORIZONTAL`, `VERTICAL`	yes
`├ alignment`	string	Alignment type: `LEFT`, `RIGHT`	yes
`├ content`	string	Card content. Must contain media or a title.	yes
`│ ├ title`	string	Title of the card, displayed as bolded text.	no
`│ ├ description`	string	Description of the card, displayed as regular text.	no
`│ ├ media`	object	Object defining display of card media.	no
`│ │ ├ file`	object	Resource object describing the main media of the card.	yes
`│ │ │ └ url`	string	Specifies the URL of the media resource. Supported content types include: image/jpeg, image/jpg, image/gif, image/png, video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm. Note that support for specific content types may vary depending on the mobile network operator. Maximum recommended file sizes: 10 MB for videos, 2 MB for images. Aspect ratios: VERTICAL orientation: MEDIUM height 2:1 (for example, 960 x 480), SHORT height 3:1 (for example, 1080 x 360) HORIZONTAL orientation: 3:4 (for example, 720 x 960)	yes
`│ │ ├ thumbnail`	object	Resource object describing the thumbnail of the card, applicable to video files only.	no
`│ │ │ └ url`	string	URL of the given resource.	yes
`│ │ └ height`	string	Height of the card media: SHORT, MEDIUM, TALL	yes
`│ ├ suggestions`	Array of objects [0..11] items	List of suggestions.	no
`│ │ ├ type`	string	Suggestion type: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `CREATE_CALENDAR_EVENT`	yes
`│ │ ├ text`	string	Suggestion text.	yes
`│ │ ├ postbackData`	string	Value which is going to be sent as a reply to a suggestion.	yes
`│ │ ├ url`	string	URL that will be opened on mobile phone when the suggestion is selected. Must be a valid URI as defined in RFC 3986. Not all URI formats will be supported on all networks.	yes, if suggestions type=`OPEN_URL`
`│ │ ├ application`	string	The application type to open the URL: `BROWSER` (default) or `WEBVIEW`	no
`│ │ ├ webviewViewMode`	string	Size of the webview window: `FULL` (full screen), `HALF` or `TALL` (three quarters)	yes, if application=`WEBVIEW`
`│ │ ├ phoneNumber`	string	Valid phone number.	yes, if suggestions type=`DIAL_PHONE`
`│ │ ├ latitude`	number [ -90 .. 90 ]	Latitude of the location.	yes, if suggestions type=`SHOW_LOCATION`
`│ │ ├ longitude`	number [ -180 .. 180 ]	Longitude of the location.	yes, if suggestions type=`SHOW_LOCATION`
`│ │ ├ label`	string	Label of the location.	no
`│ │ ├ title`	string	Event title.	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`│ │ ├ description`	string	Event description.	no
`│ │ ├ startTime`	string	The date and time when the event starts. It must be in the future and before endTime. The required format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (for example, 2030-03-03T15:00:00.000+01:00).	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`│ │ └ endTime`	string	The date and time when the event ends. It must be in the future and after startTime. The required format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (for example, 2030-03-03T17:00:00.000+01:00).	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`├ suggestions`	Array of objects [0..11] items	List of suggestions.	no
`│ ├ type`	string	Suggestion type: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `CREATE_CALENDAR_EVENT`	yes
`│ ├ text`	string	Suggestion text.	yes
`│ ├ postbackData`	string	Value which is going to be sent as a reply to a suggestion.	yes
`│ ├ url`	string	URL that will be opened on mobile phone when the suggestion is selected. Must be a valid URI as defined in RFC 3986. Not all URI formats will be supported on all networks.	yes, if suggestions type=`OPEN_URL`
`│ ├ application`	string	The application type to open the URL: `BROWSER` (default) or `WEBVIEW`	no
`│ ├ webviewViewMode`	string	Size of the webview window: `FULL` (full screen), `HALF` or `TALL` (three quarters)	yes, if application=`WEBVIEW`
`│ ├ phoneNumber`	string	Valid phone number.	yes, if suggestions type=`DIAL_PHONE`
`│ ├ latitude`	number [ -90 .. 90 ]	Latitude of the location.	yes, if suggestions type=`SHOW_LOCATION`
`│ ├ longitude`	number [ -180 .. 180 ]	Longitude of the location.	yes, if suggestions type=`SHOW_LOCATION`
`│ ├ label`	string	Label of the location.	no
`│ ├ title`	string	Event title.	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`│ ├ description`	string	Event description.	no
`│ ├ startTime`	string	The date and time when the event starts. It must be in the future and before endTime. The required format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (for example, 2030-03-03T15:00:00.000+01:00).	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`│ └ endTime`	string	The date and time when the event ends. It must be in the future and after startTime. The required format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (for example, 2030-03-03T17:00:00.000+01:00).	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`templateName`	string	Message template.	yes, if `content` not provided

","urlObject":{"path":["messaging","send"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"a2d6e7ed-b587-4ee4-9737-7c2128937422","name":"Sending RCS CARD Messages","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"RCS\",\n \"from\":\"Sender Name\",\n \"to\":\"2125551234\",\n \"content\":{\n \"type\":\"CARD\",\n \"orientation\":\"HORIZONTAL\",\n \"alignment\":\"RIGHT\",\n \"content\":{\n \"title\":\"Title of the card, displayed as bolded text.\",\n \"description\":\"Description of the card, displayed as regular text.\",\n \"media\":{\n \"file\":{\n \"url\":\"http://yoururl.com/remote_file.jpg\"\n },\n \"thumbnail\":{\n \"url\":\"http://yoururl.com/remote_thumbnail.jpg\"\n },\n \"height\":\"SHORT\"\n },\n \"suggestions\":[\n {\n \"type\":\"DIAL_PHONE\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\",\n \"phoneNumber\":\"2125651233\"\n }\n ]\n },\n \"suggestions\":[\n {\n \"type\":\"REPLY\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.thinq.com/messaging/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\":200,\n \"message\":\"Message sent\",\n \"data\":{\n \"guid\":\"0713ab1e-a78c-4f2e-97eb-7303da766afc\"\n }\n}"}],"_postman_id":"e3075676-60d8-4d2c-a2e0-b0dc0677fd33"},{"name":"Carousel","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"a9146729-8ea4-44ad-8c8b-edf6a3b49f4a","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"RCS\",\n \"from\":\"Sender Name\",\n \"to\":\"2125551234\",\n \"content\":{\n \"type\":\"CAROUSEL\",\n \"cardWidth\":\"SMALL|MEDIUM\",\n \"contents\":[\n {\n \"title\":\"Title of the card, displayed as bolded text.\",\n \"description\":\"Description of the card, displayed as regular text.\",\n \"media\":{\n \"file\":{\n \"url\":\"http://yoururl.com/remote_file.jpg\"\n },\n \"thumbnail\":{\n \"url\":\"http://yoururl.com/remote_thumbnail.jpg\"\n },\n \"height\":\"SHORT|MEDIUM|TALL\"\n },\n \"suggestions\":[\n {\n \"type\":\"REPLY|OPEN_URL|DIAL_PHONE|SHOW_LOCATION|REQUEST_LOCATION|CREATE_CALENDAR_EVENT\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n }\n ],\n \"suggestions\":[\n {\n \"type\":\"REPLY|OPEN_URL|DIAL_PHONE|SHOW_LOCATION|REQUEST_LOCATION|CREATE_CALENDAR_EVENT\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n }\n}"},"url":"https://api.thinq.com/messaging/send","description":"

You can use the token created in the Configure Send Token section to use this resource.

You can use 10DLC, TF or Short Codes as the destination number.

key	type	description	required
`channel`	string	`RCS`	yes
`from`	string	Sender name.	yes
`to`	string	Destination number.	yes
`content`	object	Message content.	yes, if `templateName` not provided
`├ type`	string	Content type: `CAROUSEL`	yes
`├ cardWidth`	string	Width of cards contained within the carousel: `SMALL`, `MEDIUM`	yes
`├ contents`	Array of objects [2 .. 10] items	An array of cards contained within the carousel.	yes
`│ ├ title`	string	Title of the card, displayed as bolded text.	no
`│ ├ description`	string	Description of the card, displayed as regular text.	no
`│ ├ media`	object	Object defining display of card media.	no
`│ │ ├ file`	object	Resource object describing the main media of the card.	yes
`│ │ │ └ url`	string	Specifies the URL of the media resource. Supported content types include: image/jpeg, image/jpg, image/gif, image/png, video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm. Note that support for specific content types may vary depending on the mobile network operator. Maximum recommended file sizes: 10 MB for videos, 2 MB for images. Aspect ratios: VERTICAL orientation: MEDIUM height 2:1 (for example, 960 x 480), SHORT height 3:1 (for example, 1080 x 360) HORIZONTAL orientation: 3:4 (for example, 720 x 960)	yes
`│ │ ├ thumbnail`	object	Resource object describing the thumbnail of the card, applicable to video files only.	no
`│ │ │ └ url`	string	URL of the given resource.	yes
`│ │ └ height`	string	Height of the card media: `SHORT`,`MEDIUM`, `TALL`	yes
`│ ├ suggestions`	Array of objects [0..11] items	List of suggestions.	no
`│ │ ├ type`	string	Suggestion type: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `CREATE_CALENDAR_EVENT`	yes
`│ │ ├ text`	string	Suggestion text.	yes
`│ │ ├ postbackData`	string	Value which is going to be sent as a reply to a suggestion.	yes
`│ │ ├ url`	string	URL that will be opened on mobile phone when the suggestion is selected. Must be a valid URI as defined in RFC 3986. Not all URI formats will be supported on all networks.	yes, if suggestions type=`OPEN_URL`
`│ │ ├ application`	string	The application type to open the URL: `BROWSER` (default) or `WEBVIEW`	no
`│ │ ├ webviewViewMode`	string	Size of the webview window: `FULL` (full screen), `HALF` or `TALL` (three quarters)	yes, if application=`WEBVIEW`
`│ │ ├ phoneNumber`	string	Valid phone number.	yes, if suggestions type=`DIAL_PHONE`
`│ │ ├ latitude`	number [ -90 .. 90 ]	Latitude of the location.	yes, if suggestions type=`SHOW_LOCATION`
`│ │ ├ longitude`	number [ -180 .. 180 ]	Longitude of the location.	yes, if suggestions type=`SHOW_LOCATION`
`│ │ ├ label`	string	Label of the location.	no
`│ │ ├ title`	string	Event title.	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`│ │ ├ description`	string	Event description.	no
`│ │ ├ startTime`	string	The date and time when the event starts. It must be in the future and before endTime. The required format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (for example, 2030-03-03T15:00:00.000+01:00).	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`│ │ └ endTime`	string	The date and time when the event ends. It must be in the future and after startTime. The required format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (for example, 2030-03-03T17:00:00.000+01:00).	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`├ suggestions`	Array of objects [0..11] items	List of suggestions.	no
`│ ├ type`	string	Suggestion type: `REPLY`, `OPEN_URL`, `DIAL_PHONE`, `SHOW_LOCATION`, `REQUEST_LOCATION`, `CREATE_CALENDAR_EVENT`	yes
`│ ├ text`	string	Suggestion text.	yes
`│ ├ postbackData`	string	Value which is going to be sent as a reply to a suggestion.	yes
`│ ├ url`	string	URL that will be opened on mobile phone when the suggestion is selected. Must be a valid URI as defined in RFC 3986. Not all URI formats will be supported on all networks.	yes, if suggestions type=`OPEN_URL`
`│ ├ application`	string	The application type to open the URL: `BROWSER` (default) or `WEBVIEW`	no
`│ ├ webviewViewMode`	string	Size of the webview window: `FULL` (full screen), `HALF` or `TALL` (three quarters)	yes, if application=`WEBVIEW`
`│ ├ phoneNumber`	string	Valid phone number.	yes, if suggestions type=`DIAL_PHONE`
`│ ├ latitude`	number [ -90 .. 90 ]	Latitude of the location.	yes, if suggestions type=`SHOW_LOCATION`
`│ ├ longitude`	number [ -180 .. 180 ]	Longitude of the location.	yes, if suggestions type=`SHOW_LOCATION`
`│ ├ label`	string	Label of the location.	no
`│ ├ title`	string	Event title.	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`│ ├ description`	string	Event description.	no
`│ ├ startTime`	string	The date and time when the event starts. It must be in the future and before endTime. The required format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (for example, 2030-03-03T15:00:00.000+01:00).	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`│ └ endTime`	string	The date and time when the event ends. It must be in the future and after startTime. The required format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (for example, 2030-03-03T17:00:00.000+01:00).	yes, if suggestions type=`CREATE_CALENDAR_EVENT`
`templateName`	string	Message template.	yes, if `content` not provided

","urlObject":{"path":["messaging","send"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"9985fb79-6393-4da3-84ac-19da97a22632","name":"Sending RCS CAROUSEL Messages","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"RCS\",\n \"from\":\"Sender Name\",\n \"to\":\"2125551234\",\n \"content\":{\n \"type\":\"CAROUSEL\",\n \"cardWidth\":\"MEDIUM\",\n \"contents\":[\n {\n \"title\":\"Title of the first card, displayed as bolded text.\",\n \"description\":\"Description of the second card, displayed as regular text.\",\n \"media\":{\n \"file\":{\n \"url\":\"http://yoururl.com/remote_file.jpg\"\n },\n \"thumbnail\":{\n \"url\":\"http://yoururl.com/remote_thumbnail.jpg\"\n },\n \"height\":\"MEDIUM\"\n },\n \"suggestions\":[\n {\n \"type\":\"SHOW_LOCATION\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\",\n \"latitude\":87.12,\n \"longitude\":-120.12,\n \"label\":\"My location\"\n }\n ]\n },\n {\n \"title\":\"Title of the second card, displayed as bolded text.\",\n \"description\":\"Description of second the card, displayed as regular text.\",\n \"media\":{\n \"file\":{\n \"url\":\"http://yoururl.com/remote_file.jpg\"\n },\n \"height\":\"MEDIUM\"\n },\n \"suggestions\":[\n {\n \"type\":\"REPLY\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n }\n ],\n \"suggestions\":[\n {\n \"type\":\"REPLY\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.thinq.com/messaging/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\":200,\n \"message\":\"Message sent\",\n \"data\":{\n \"guid\":\"0713ab1e-a78c-4f2e-97eb-7303da766afc\"\n }\n}"}],"_postman_id":"a9146729-8ea4-44ad-8c8b-edf6a3b49f4a"},{"name":"Sending RCS with Fallback SMS","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"246ce0bf-3258-40ef-9538-6da59df1abb5","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"RCS\",\n \"from\":\"Sender Name\",\n \"to\":\"2125551234\",\n \"smsFallback\": {\n \"number\": \"2125551235\",\n \"message\": \"Fallback message\"\n },\n \"content\":{\n \"type\":\"TEXT\",\n \"text\":\"Text Message Body\",\n \"suggestions\":[\n {\n \"type\":\"REPLY|OPEN_URL|DIAL_PHONE|SHOW_LOCATION|REQUEST_LOCATION|CREATE_CALENDAR_EVENT\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n }\n}"},"url":"https://api.thinq.com/messaging/send","description":"

You can use the token created in the Configure Send Token section to use this resource.

You will be able provide a fallback phone number (10DLC, TF or Short Code) and a fallback message to be sent in the situation that the RCS message cannot be delivered to the handset due to RCS Business Messaging not being enabled on the handset. You can append these properties to any of the RCS sending examples above.

You will receive a final DLR from this send attempt as well.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

key	type	description	required
`smsFallback`	object	SMS fallback data object	no
`├ number`	string	Fallback From number.	yes
`├ message`	string	Fallback message content.	yes

","urlObject":{"path":["messaging","send"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"49bfeae6-f5ef-4e3b-a9a0-3dd461592291","name":"Sending RCS with Fallback SMS","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"RCS\",\n \"from\":\"Sender name\",\n \"to\":\"2125551234\",\n \"smsFallback\": {\n \"number\": \"2125551235\",\n \"message\": \"Fallback message\"\n },\n \"content\":{\n \"type\":\"TEXT\",\n \"text\":\"Text Message Body\",\n \"suggestions\":[\n {\n \"type\":\"REPLY\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n }\n}"},"url":"https://api.thinq.com/messaging/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\":200,\n \"message\":\"Message sent\",\n \"data\":{\n \"guid\":\"0713ab1e-a78c-4f2e-97eb-7303da766afc\"\n }\n}"}],"_postman_id":"246ce0bf-3258-40ef-9538-6da59df1abb5"},{"name":"Sending RCS with Fallback MMS","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"c9a76628-909e-46d4-9e90-95bab0c8b07f","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"RCS\",\n \"from\":\"Sender Name\",\n \"to\":\"2125551234\",\n \"mmsFallback\": {\n \"number\": \"2125551235\",\n \"message\": \"Fallback message\",\n \"url\": \"http://yoururl.com/remote_file.jpg\"\n },\n \"content\":{\n \"type\":\"TEXT\",\n \"text\":\"Text Message Body\",\n \"suggestions\":[\n {\n \"type\":\"REPLY|OPEN_URL|DIAL_PHONE|SHOW_LOCATION|REQUEST_LOCATION|CREATE_CALENDAR_EVENT\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n }\n}"},"url":"https://api.thinq.com/messaging/send","description":"

You can use the token created in the Configure Send Token section to use this resource.

You will be able provide a fallback phone number (10DLC, TF or Short Code), a fallback message and media URL to be sent in the situation that the RCS with media content message cannot be delivered to the handset due to RCS Business Messaging not being enabled on the handset. You can append these properties to any of the RCS sending examples above.

You will receive a final DLR from this send attempt as well.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

key	type	description	required
`mmsFallback`	object	MMS fallback data object	no
`├ number`	string	Fallback From number.	yes
`├ message`	string	Fallback message content.	no
`├ url`	string	Fallback media url.	yes

","urlObject":{"path":["messaging","send"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"04a8d40c-ea2b-497f-b014-d53c11893bee","name":"Sending RCS with Fallback MMS","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"RCS\",\n \"from\":\"Sender Name\",\n \"to\":\"2125551234\",\n \"mmsFallback\": {\n \"number\": \"2125551235\",\n \"message\": \"Fallback message\",\n \"url\": \"http://yoururl.com/remote_file.jpg\"\n },\n \"content\":{\n \"type\":\"FILE\",\n \"file\":{\n \"url\":\"http://yoururl.com/remote_file.jpg\"\n },\n \"thumbnail\":{\n \"url\":\"http://yoururl.com/remote_thumbnail.jpg\"\n },\n \"suggestions\":[\n {\n \"type\":\"REPLY|OPEN_URL|DIAL_PHONE|SHOW_LOCATION|REQUEST_LOCATION|CREATE_CALENDAR_EVENT\",\n \"text\":\"Suggestion text\",\n \"postbackData\":\"Value which is going to be sent as a reply to a suggestion.\"\n }\n ]\n }\n}"},"url":"https://api.thinq.com/messaging/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\":200,\n \"message\":\"Message sent\",\n \"data\":{\n \"guid\":\"0713ab1e-a78c-4f2e-97eb-7303da766afc\"\n }\n}"}],"_postman_id":"c9a76628-909e-46d4-9e90-95bab0c8b07f"},{"name":"List RCS Senders","id":"b8d5897c-298e-4624-9889-8df726743a2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/messaging/rcs/senders?rowsPerPage=25¤tPage=1&sort=createdAt:desc","description":"

Get a paginated list of all the RCS Business Messaging Senders associated with the logged in user's account

Edit the inbound, DLR and read receipt endpoint IDs for an RCS Business Messaging Sender by sender ID

Your authentication string is a base64 encoded version of username:token

Once you have saved some content as a template, you can send a message based on that content by including a templateName property instead of the content property.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

key	type	description	required
`channel`	string	`RCS`, `SMS` or `MMS`	yes
`from`	string	Sender name or number	yes
`to`	string	Destination number.	yes
`templateName`	string	Message template.	yes

","urlObject":{"path":["messaging","send"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"50d928ec-11ff-4e2a-b9dd-9fd45f798f30","name":"Sending RCS TEXT Messages","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"channel\":\"RCS\",\n \"from\":\"Sender name\",\n \"to\":\"2125551234\",\n \"templateName\": \"AcmeSale\"\n}"},"url":"https://api.thinq.com/messaging/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\":200,\n \"message\":\"Message sent\",\n \"data\":{\n \"guid\":\"0713ab1e-a78c-4f2e-97eb-7303da766afc\"\n }\n}"}],"_postman_id":"5a13911b-1bda-4309-9790-72f098b3b887"}],"id":"f140a396-680b-4f7d-991d-693a93da340a","_postman_id":"f140a396-680b-4f7d-991d-693a93da340a","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}}],"id":"320caee1-da7f-43d8-822d-0288b29f9f2c","description":"

This is our new Messaging API, which offers more functionality than our previous options for send/sms or send/mms. With this API, you can send one message to up to 100,000 recipients. This API also offers the option to send RCS messages.

\n","_postman_id":"320caee1-da7f-43d8-822d-0288b29f9f2c","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"NEW - Receive Messages","item":[{"name":"Receive SMS","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"ec2879f6-62ec-4c73-b464-b39b400b761a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"VIEW","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"thinq-sms"},{"key":"X-sms-guid","value":"*thinq SMS Guid"},{"key":"x-Attempt","value":"1"},{"key":"x-Commio-Signature","value":"377oEN/kFcppFD//1JCIvKpkxfU="}],"body":{"mode":"raw","raw":""},"url":"http://customer_url.com/message_forwarding_url","description":"

Receiving Inbound SMS/MMS Messages

\n\n

Incoming messages are received by our system and are forwarded to your servers. You will need to have a message forwarding url configured in order to support incoming messages.

\n\n

Configuring Message Forwarding URLs

\n\n

Configure an account level value in the \"Default Message Forwarding URL\" section. This is where all incoming messages will be forwarded if you do not configure a DID-level override.

\n\n

You can override the default URL for individual DIDs by using an \"SMS Routing Profile\". Once you have the routing profile configured, you can assign it to a DID in one of two ways:

\n\n

Choose the SMS Routing Profile in DID configuration on the Number Management page
Use the Origination API to assign profiles via the \"Create Feature Order\" process for DIDs

\n\n

Inbound Messages

\n\n

Messages will arrive to your URL as a form POST. The user agent will be set to \"thinq-sms\" to simplify identification. The incoming form fields will always have the same names, but the content will vary slightly depending on how your URLs are configured.

\n\n

If a message is longer than 160 characters in 7-bit encoding, 140 bytes in 8-bit encoding, or 70 characters in UCS-2 encoding, it will be split

\n\n

Incoming Form Fields

\n\n

SMS:

from: Source DID
to: Destination DID
type: sms
message: Content of the message

\n\n

MMS:

from: Source DID
to: Destination DID
type: mms
message: URL or base64 representation of the media attachment, depending on your settings
contentType: A string indicating the MIME type of the file on the MMS message

MMS - Single Webhook:

from: Source DID
to: Destination DID
type: MMS
message: Text component of the MMS
attachments: Array of media attachments, either URLs or base64 representations, depending on your settings
contentType: An array of strings indicating the MIME type of the file on the MMS message. The content type for a given attachment is in the same positional order as the attachment is in the attachments array.

You can change the MMS attachment style on your inbound message settings.

Format of Message Field

\n\n

The content of the \"message\" field will vary based on the message type and how your inbound URL is configured.

\n\n

SMS: Standard text message
MMS with URL attachments: URL(s) of the binary attachment on a remote host
MMS with Binary attachments: Base 64 encoded version of the binary attachment(s)

","urlObject":{"protocol":"http","path":["message_forwarding_url"],"host":["customer_url","com"],"query":[],"variable":[]}},"response":[{"id":"c029ec10-62ba-48db-9443-8c3f6e46a639","name":"Receive SMS","originalRequest":{"method":"VIEW","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token","disabled":true},{"key":"Content-Type","value":"application/json","disabled":true}],"body":{"mode":"raw","raw":""},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json","description":""},{"key":"User-Agent","value":"thinq-sms","description":""},{"key":"X-sms-guid","value":"002eb8a5-db92-4c96-b410-8476a35a2346","description":""},{"key":"x-Attempt","value":"1","description":""},{"key":"x-Commio-Signature","value":"293oEN/kFcppFD//1JCIvKpkxfU=","description":""}],"cookie":[],"responseTime":null,"body":"SMS:\n from=9198900000\n to=2125551234\n type=sms\n message=Text+Message+Body"}],"_postman_id":"ec2879f6-62ec-4c73-b464-b39b400b761a"},{"name":"Receive MMS","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"7daa1442-db75-467e-99a6-a691e228643f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"VIEW","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"thinq-sms"},{"key":"X-sms-guid","value":"*thinq SMS Guid"},{"key":"x-Attempt","value":"1"},{"key":"x-Commio-Signature","value":"377oEN/kFcppFD//1JCIvKpkxfU="}],"body":{"mode":"raw","raw":""},"url":"http://customer_url.com/message_forwarding_url","description":"

Receiving Inbound SMS/MMS Messages

\n\n

Incoming messages are received by our system and are forwarded to your servers. You will need to have a message forwarding url configured in order to support incoming messages.

\n\n

Configuring Message Forwarding URLs

\n\n

Configure an account level value in the \"Default Message Forwarding URL\" section. This is where all incoming messages will be forwarded if you do not configure a DID-level override.

\n\n

You can override the default URL for individual DIDs by using an \"SMS Routing Profile\". Once you have the routing profile configured, you can assign it to a DID in one of two ways:

\n\n

Choose the SMS Routing Profile in DID configuration on the Number Management page
Use the Origination API to assign profiles via the \"Create Feature Order\" process for DIDs

\n\n

Inbound Messages

\n\n

If a message is longer than 160 characters in 7-bit encoding, 140 bytes in 8-bit encoding, or 70 characters in UCS-2 encoding, it will be split

\n\n

Incoming Form Fields

\n\n

SMS:

from: Source DID
to: Destination DID
type: sms
message: Content of the message

\n\n

MMS:

from: Source DID
to: Destination DID
type: mms
message: URL or base64 representation of the media attachment, depending on your settings
contentType: A string indicating the MIME type of the file on the MMS message

MMS - Single Webhook:

from: Source DID
to: Destination DID
type: MMS
message: Text component of the MMS
attachments: Array of media attachments, either URLs or base64 representations, depending on your settings
contentType: An array of strings indicating the MIME type of the file on the MMS message. The content type for a given attachment is in the same positional order as the attachment is in the attachments array.

You can change the MMS attachment style on your inbound message settings.

Format of Message Field

\n\n

The content of the \"message\" field will vary based on the message type and how your inbound URL is configured.

\n\n

SMS: Standard text message
MMS with URL attachments: URL(s) of the binary attachment on a remote host
MMS with Binary attachments: Base 64 encoded version of the binary attachment(s)

","urlObject":{"protocol":"http","path":["message_forwarding_url"],"host":["customer_url","com"],"query":[],"variable":[]}},"response":[{"id":"15593b68-d561-4ab8-a1c2-28983102cccf","name":"Receive MMS","originalRequest":{"method":"VIEW","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token","disabled":true},{"key":"Content-Type","value":"application/json","disabled":true}],"body":{"mode":"raw","raw":""},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json","description":""},{"key":"User-Agent","value":"thinq-sms","description":""},{"key":"X-sms-guid","value":"002eb8a5-db92-4c96-b410-8476a35a2346","description":""},{"key":"x-Attempt","value":"1","description":""},{"key":"x-Commio-Signature","value":"293oEN/kFcppFD//1JCIvKpkxfU=","description":""}],"cookie":[],"responseTime":null,"body":"MMS (Single webhook, URL attachments):\n from=9198900000\n to=2125551234\n type=mms\n message=MMS+text+here\n attachments[0]=https://storage.googleapis.com/hermes-mms/339fda2e-608c-11ef.jpg\n contentType[0]=image/jpg\n\nMMS (Single webhook, Base64 attachments):\n from=9198900000\n to=2125551234\n type=mms\n message=MMS+text+here\n attachments[0]=4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAA\n contentType[0]=image/png\n\nMMS (Separate webhooks, URL attachments):\n Message 1:\n from=9198900000\n to=2125551234\n type=mms\n message=MMS+text+here\n\n Message 2:\n from=9198900000\n to=2125551234\n type=mms\n message=https://storage.googleapis.com/hermes-mms/339fda2e-608c-11ef.gif\n contentType=image/gif\n\nMMS (Separate webhooks, Base64 attachments):\n Message 1:\n from=9198900000\n to=2125551234\n type=mms\n message=MMS+text+here\n\n Message 2:\n from=9198900000\n to=2125551234\n type=mms\n message=4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAA\n contentType=image/jpg\n\n"}],"_postman_id":"7daa1442-db75-467e-99a6-a691e228643f"},{"name":"Receive RCS","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"d120b5dc-848c-49cf-a75c-4a3e2d91f12b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"VIEW","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"thinq-sms"},{"key":"X-sms-guid","value":"*thinq SMS Guid"},{"key":"x-Attempt","value":"1"},{"key":"x-Commio-Signature","value":"377oEN/kFcppFD//1JCIvKpkxfU="}],"body":{"mode":"raw","raw":""},"url":"http://customer_url.com/message_forwarding_url","description":"

Receiving Inbound RCS Messages

\n\n

Incoming RCS messages are received by our system and are forwarded to your servers. You will need to have a message forwarding url configured in order to support incoming RCS messages.

\n\n

ReferenceVerify Webhooksfor information on how to verify the Commio X-Commio-Signature header for incoming webhooks.

\n\n

Configuring Inbound Message Forwarding URLs

\n\n

Configure an account level value in theDefault Inbound Messaging URLsection. This is where all incoming messages will be forwarded if you do not configure an RCS Sender-level override.

You can override the default URL for individual RCS Senders byCreating a New Messaging Routing Profile. Once you have the routing profile configured, you can assign it to a Sender by choosing the SMS Routing Profile on the RCS Senders list page

\n\n

Inbound RCS Messages

\n\n

If a message is longer than 160 characters in 7-bit encoding (ASCII), 140 bytes in 8-bit encoding (UTF-8), or 70 characters in UCS-2 encoding, it will be split

\n\n

Incoming Form Fields

\n\n

from: Source DID
to: Destination RCS Sender
type: rcs
rcs: Content of the message

\n\n

Format of `rcs` Field

\n\n

The content of the \"rcs\" field will be an object and vary based on the RCS message type. The message field will always include the RCS \"type\" property, which will be one of the following: TEXT, FILE, LOCATION or SUGGESTION.

\n\n

TEXT type
- Additional Properties:
  - \"text\": String. The text of the incoming message
FILE type
- Additional Properties:
  - \"url\": String. The URL of the file sent in the incoming message
  - \"name\": String. The name of the file sent in the incoming message
  - \"contentType\": String. The content type of the file sent in the incoming message
  - \"size\": Integer. The size of the file sent in the incoming message, expressed in bytes. Minimum value is 0.
LOCATION type
- Additional Properties:
  - \"latitude\": Number. Value between -90 and 90
  - \"longitude\": Number. Value between -180 and 180
SUGGESTION type
- Additional Properties:
  - \"text\": String. Incoming suggestion text
  - \"postbackData\": String. Postback data of incoming suggestion

\n\n

form-urlencoded Format

If your endpoint is configured to receive inbound messages as form-urlencoded data, the object in the rcs field will be flattened into camel case strings. For example, if the JSON payload is:

{\n  ...\n  \"rcs\": {\n    \"text\": \"Hello!\",\n    \"type\": \"TEXT\"\n  }\n  ...\n}\n\n

then the form-urlencoded data will include

rcsText=hello&rcsType=TEXT

\n","urlObject":{"protocol":"http","path":["message_forwarding_url"],"host":["customer_url","com"],"query":[],"variable":[]}},"response":[{"id":"0677b582-1c29-456e-a700-378e33e60936","name":"Receive RCS","originalRequest":{"method":"VIEW","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token","disabled":true},{"key":"Content-Type","value":"application/json","disabled":true}],"body":{"mode":"raw","raw":""},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json","description":""},{"key":"User-Agent","value":"thinq-sms","description":""},{"key":"X-sms-guid","value":"002eb8a5-db92-4c96-b410-8476a35a2346","description":""},{"key":"x-Attempt","value":"1","description":""},{"key":"x-Commio-Signature","value":"293oEN/kFcppFD//1JCIvKpkxfU=","description":""}],"cookie":[],"responseTime":null,"body":"JSON TEXT:\n{\n \"from\": \"9198900000\",\n \"to\": \"SenderName\",\n \"type\": \"rcs\",\n \"rcs\": { \"type\": \"TEXT\", \"text\": \"Hello\" }\n}\n\nform-urlencoded TEXT:\n\nfrom=9198900000&to=SenderName&type=rcs&rcsType=TEXT&rcsText=Hello\n\nJSON FILE:\n{\n \"from\": \"9198900000\",\n \"to\": \"SenderName\",\n \"type\": \"rcs\",\n \"rcs\": { \"type\":\"FILE\", \"url\":\"http://sample.com\", \"name\":\"Sample\", \"contentType\":\"json\", \"size\": 25 }\n}\n\nform-urlencoded FILE:\n\nfrom=9198900000&to=SenderName&type=rcs&rcsType=FILE&rcsUrl=http%3A%2F%2Fsample.com&rcsName=Sample&rcsContentType=json&rcsSize=25\n\nJSON LOCATION:\n{\n \"from\": \"9198900000\",\n \"to\": \"SenderName\",\n \"type\": \"rcs\",\n \"rcs\": { \"type\": \"LOCATION\", \"latitude\": 90, \"longitude\": -90 }\n}\n\nform-urlencoded LOCATION:\n\nfrom=9198900000&to=SenderName&type=rcs&rcsType=LOCATION&rcsLatitude=90&rcsLongitude=-90\n\n\nJSON SUGGESTION:\n{\n \"from\": \"9198900000\",\n \"to\": \"SenderName\",\n \"type\": \"rcs\",\n \"rcs\": { \"type\": \"SUGGESTION\", \"text\": \"Hello\", \"postbackData\": \"Positive\" }\n}\n\nform-urlencoded SUGGESTION:\n\nfrom=9198900000&to=SenderName&type=rcs&rcsType=SUGGESTION&rcsText=Hello&rcsPostbackdata=Positive\n"}],"_postman_id":"d120b5dc-848c-49cf-a75c-4a3e2d91f12b"},{"name":"Receive Delivery Notifications","id":"c3ae07e6-1f7c-4bc4-b301-9ea8c41547d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"VIEW","header":[{"key":"useragent","value":"thinq-sms"}],"body":{"mode":"raw","raw":""},"url":"http://customer_url.com/message_forwarding_url","description":"

Receiving Delivery Notification for Outbound RCS Messages

\n\n

Delivery notifications include both confirmations and failures. Incoming notifications are received by our system and are forwarded to your servers. You will need to have a \"Delivery Confirmation URL\" configured in order to support incoming notifications. This feature allows us to push updates for individual messages to your system in real time.

\n\n

Reference Verify Webhooks for information on how to verify the Commio X-Commio-Signature header for incoming webhooks.

\n\n

Delivery Confirmation URL

\n\n

Configure an account level value in the Default DLR Settings section. This is where all incoming delivery notifications will be forwarded if you do not configure an RCS Sender-level override.

\n\n

You can override the default URL for individual RCS Senders by Creating Custom DLR Settings. Once you have the settings configured, you can assign them to a Sender by choosing the DLR Settings on the RCS Senders list page

\n\n

Delivery Notification Type

\n\n

Incoming delivery notifications can be forwarded as either JSON payloads or form POSTs. You configured option will determine the inbound format.

\n\n

Incoming Form POST

\n\n

guid: thinQ guid returned when an outbound RCS message is sent via our API
\n
account_id: Your thinQ account ID
\n
from: Source DID
\n
to: Destination Sender
\n
channel: RCS
\n
timestamp: Time the delivery notification was received
\n
send_status: User friendly version of the status (i.e.: delivered)
\n
status: System version of the status (i.e.: DELIVRD)
\n
error: Error code if any (i.e.: 000)
\n

Incoming JSON

\n\n

{\n  \"guid\": \"3ccdaa4c-1996-xxxx-xxxx-xxxxxxx\",\n  \"account_id\": \"xxxxx\",\n  \"from\": \"9198900000\",\n  \"to\": \"Commio\",\n  \"channel\": \"RCS\",\n  \"timestamp\": \"2023-05-18T21:59:28.000Z\",\n  \"send_status\": \"delivered\",\n  \"status\": \"DELIVRD\",\n  \"error\": \"000\"\n}\n\n

Possible Status/Error Code Combinations

100 / SENT - The message was sent off to the carrier for delivery.
\n
110 / ACCEPTD - The carrier has acknowledged the message was received.
\n
000 / DELIVRD - The message has been delivered to the destination number.
\n
003 / EXPIRED - The message timed out in the carrier's system before delivery could be attempted.
\n
004 / DELETED - The carrier deleted the message prior to delivery.
\n
005 / UNDELIV - The carrier was unable to deliver the message to the destination number.
\n
007 / UNKNOWN - Unknown error
\n

Test DLR webhook

You can recieve a test DLR webhook by sending an RCS to one of the following numbers, depending on the type of DLR you would like to recieve. This will perform all the normal checks but will not send the RCS and will not incur any charges. The webhook will be sent to the DLR endpoint configured on your sending number, or your account default if a number specific endpoint is not set.

9195550000 - Delivered
\n
9195555555 - Undelivered
\n

\n","urlObject":{"protocol":"http","path":["message_forwarding_url"],"host":["customer_url","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3ae07e6-1f7c-4bc4-b301-9ea8c41547d8"},{"name":"Receive Read Receipts (RCS Only)","id":"e374ac62-9ade-4c2f-a283-deaa72742151","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"http://customer_url.com/read-receipt-url","description":"

Receiving Read Receipts for Outbound RCS Messages

\n\n

Read Receipts are triggered when a handset has read receipts turned on and view your RCS message. You will need to have a \"Read Receipt URL\" configured in order to support incoming read receipts. This feature allows us to push updates for individual messages to your system in real time.

\n\n

Reference Verify Webhooks for information on how to verify the Commio X-Commio-Signature header for incoming webhooks.

\n\n

Read Receipts URL

\n\n

Configure an account level value in your account's message settings page. By setting a default Read Receipt URL, all read receipt webhooks for all senders will be directed to the default URL.

\n\n

You can override the default URL for individual RCS Senders by creating individual Read Receipt URLs. Once you have the settings configured, you can assign them to a Sender by choosing the Read Receipt Settings on the RCS Senders list page

\n\n

Incoming read receipts can be forwarded as either application/json or application/x-www-form-urlendcoded . You configured option will determine the inbound format.

\n\n

Incoming Form POST

\n\n

guid: thinQ guid returned when an outbound RCS message is sent via our API
\n
to: the destsination for the RCS message
\n
from: the original sender of the RCS message
\n
sentAt: an ISO timestamp of when the RCS message was sent
\n
seenAt: an ISO timestamp of when the RCS message was viewed on the phone
\n

Incoming JSON and example

\n\n

{\n    \"guid\": \"293f928h3f-23f23f2g-2323g23nfdf\",\n    \"to\": \"14567891234\",\n    \"from\": \"Sender\",\n    \"sentAt\": \"2025-06-13T13:55:45.543Z\",\n    \"seenAt\": \"2025-06-13T14:00:45.543Z\"\n}\n\n

Use this resource to create a URL where you'd like your inbound messages to be delivered. This is an account level value where all inbound messages will be forwarded, unless the TO number has a custom inbound setting.

URL must be public-facing with no authentication required
Incoming requests will be from 192.81.236.250. Please update your firewall rules as appropriate.

You can choose to set your attachment type (binary or URL). You can choose to set how you'd like to receive inbound MMS (Single Webhook or Separate Webhook). A single webhook will combine the MMS file attachment and MMS text into one webhook. Setting \"Separate\" webhooks will send the MMS file attachment and MMS text in two separate webhooks back to your specified URL.

For examples of the inbound message format, go here: https://apidocs.thinq.com/#9c5ae132-fc3c-44c6-85a0-cd08fa66f720

\n","urlObject":{"path":["account","{{account_id}}","product","origination","sms","url"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"df33c5cc-c452-4fda-a501-28f8e511e46b","name":"Account Default Message Forwarding URL","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"http://url.com\",\n \"attachment_type\": \"binary|url\",\n \"id\": \"XX\",\n \"type\": \"account_origination_sms_url\"\n}"}],"_postman_id":"d6e3f9fa-8eeb-4090-be1d-802104d03edd"},{"name":"Create New Messaging Routing Profile","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","type":"text/javascript","exec":["",""]}}],"id":"25d865d1-22b6-4187-84a8-644f8accba5b","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"sms_routing_profile\":\n {\n \"name\": \"Profile Name\",\n \"url\": \"http://url.com/sms_callback.php\",\n \"attachment_type\": \"binary|url\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/profile","description":"

Use this resource to create a new Messaging Routing Profile. A Messaging Routing Profile will allow you to configure the message forwarding URL for inbound messages. URL must be public-facing with no authentication required Incoming requests will be from 192.81.236.250. Please update your firewall rules as appropriate.

\n\n

The \"Attachment Type\" setting will tell us how you wish to receive binary content for MMS messages. There are currently two options

\n\n

URL: URL of the binary attachment on a remote host
Binary: Base 64 encoded version of the binary attachment

","urlObject":{"path":["account","{{account_id}}","product","origination","sms","profile"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"946c646a-5642-4074-85c4-4d854cd3652f","name":"Create New Messaging Routing Profile","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"sms_routing_profile\":\n {\n \"name\": \"Profile Name\",\n \"url\": \"http://url.com/sms_callback.php\",\n \"attachment_type\": \"binary|url\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/profile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"account_id\": XX,\n \"name\": \"Messaging Route\",\n \"url\": \"http://url.com/messaging_callback.php\",\n \"attachment_type\": \"binary|url\",\n \"id\": XX,\n \"type\": \"sms_routing_profile\"\n}"}],"_postman_id":"25d865d1-22b6-4187-84a8-644f8accba5b"},{"name":"Existing Messaging Routing Profiles","event":[{"listen":"test","script":{"id":"332f5524-29cb-48e6-8f61-223c3d2a5405","type":"text/javascript","exec":["","","pm.test(\"Rows Returned\", function () {"," var jsonData = pm.response.json();"," console.log(jsonData.rows[0]);"," "," pm.environment.set(\"selected_did\", JSON.stringify(jsonData.rows[0]));"," //pm.expect(jsonData.value).to.eql(100);","});","","",""]}}],"id":"7ba68818-004f-4028-9c1a-ec2e286319c9","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/profile?page=1&rows=1","description":"

List of all of the messaging routing profiles within a specific account.

\n","urlObject":{"path":["account","{{account_id}}","product","origination","sms","profile"],"host":["https://api.thinq.com"],"query":[{"key":"page","value":"1"},{"key":"rows","value":"1"}],"variable":[]}},"response":[{"id":"2d4a7f4c-90f0-4a8d-a35e-ec8aed3a1223","name":"List Existing Messaging Routing Profiles","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/profile?page=1&rows=1","host":["https://api.thinq.com"],"path":["account","{{account_id}}","product","origination","sms","profile"],"query":[{"key":"page","value":"1"},{"key":"rows","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total_rows\": 3,\n \"has_next_page\": false,\n \"page\": 3,\n \"rows_per_page\": 1,\n \"rows\": [\n {\n \"account_id\": \"XX\",\n \"name\": \"Messaging Route\",\n \"url\": \"http://url.com/messaging_callback.php\",\n \"attachment_type\": \"binary|url\",\n \"id\": XX,\n \"type\": \"sms_routing_profile\"\n }\n ]\n}"}],"_postman_id":"7ba68818-004f-4028-9c1a-ec2e286319c9"},{"name":"Single Messaging Routing Profile","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","type":"text/javascript","exec":["",""]}}],"id":"9fd29640-423c-468a-846e-79ca2f22a64c","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/profile/{{profile_id}}","description":"

Retrieve a single messaging routing profile by the \"profile_id\".

\n","urlObject":{"path":["account","{{account_id}}","product","origination","sms","profile","{{profile_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"f9178d62-4a5e-4423-9057-aace326c5c78","name":"Retrieve Single Messaging Routing Profile","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/profile/{{profile_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"account_id\": XX,\n \"name\": \"Messaging Route\",\n \"url\": \"http://url.com/messaging_callback.php\",\n \"attachment_type\": \"binary|url\",\n \"id\": XX,\n \"type\": \"sms_routing_profile\"\n}"}],"_postman_id":"9fd29640-423c-468a-846e-79ca2f22a64c"},{"name":"Update Messaging Routing Profile","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","type":"text/javascript","exec":["",""]}}],"id":"d6facbdd-1792-4495-baa9-a551dba0562f","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

Use this resource to update a Messaging Routing Profile. A Messaging Routing Profile allows you to configure the message forwarding URL for inbound messages. URL must be public-facing with no authentication required Incoming requests will be from 192.81.236.250. Please update your firewall rules as appropriate.

\n\n

The \"Attachment Type\" setting will tell us how you wish to receive binary content for MMS messages. There are currently two options

\n\n

URL: URL of the binary attachment on a remote host
Binary: Base 64 encoded version of the binary attachment

","urlObject":{"path":["account","{{account_id}}","product","origination","sms","profile","{{profile_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"9120f41d-dff5-47cd-946b-4c41e76c99ae","name":"Update Existing Messaging Routing Profile","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"sms_routing_profile\":\n {\n \"name\": \"Profile Name\",\n \"url\": \"http://url.com/sms_callback.php\",\n \"attachment_type\": \"binary|url\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/profile/{{profile_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"account_id\": XX,\n \"name\": \"Messaging Route\",\n \"url\": \"http://url.com/messaging_callback.php\",\n \"attachment_type\": \"binary|url\",\n \"id\": XX,\n \"type\": \"sms_routing_profile\"\n}"}],"_postman_id":"d6facbdd-1792-4495-baa9-a551dba0562f"},{"name":"Delete Messaging Routing Profile","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","type":"text/javascript","exec":["",""]}}],"id":"9067cf0c-9af3-4d32-a07d-9fd09e17e135","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/profile/{{profile_id}}","description":"

This will delete the messaging routing profile id specified at the end of the url string.

\n","urlObject":{"path":["account","{{account_id}}","product","origination","sms","profile","{{profile_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"ceb52d98-ae34-483e-8203-e5e9c7d8dd6d","name":"Delete Existing Messaging Routing Profile","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"sms_routing_profile\":\n {\n \"name\": \"Profile Name\",\n \"url\": \"http://url.com/sms_callback.php\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/profile/{{profile_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"200 http code"}],"_postman_id":"9067cf0c-9af3-4d32-a07d-9fd09e17e135"},{"name":"Create New Custom DLR Settings","id":"3d54035c-b8ed-4964-815c-7d8cf5cb0336","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://www.customDeliveryURL.com\",\r\n \"name\": \"Custom delivery URL\",\r\n \"format\": \"json\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.thinq.com/inbound/delivery-settings","description":"

Use this resource to create a custom delivery notification URL that can be used on individual FROM numbers.

Get Default DLR Settings

\n\n

Delivery settings are a group of settings that affect the outbound flow of SMS messages. This endpoint allows you to get the settings tied to your account.

\n\n

Settings

\n\n

Delivery Confirmation URL

\n\n

An account level value that is the URL where all incoming delivery notifications will be forwarded.

\n\n

Delivery Notification Type

\n\n

Assign the format of incoming delivery notification payloads. Messages can be JSON or standard form POSTs. Supported values are \"json\" and \"form-data\".

\n\n

Incoming URL Parameters

\n\n

account_id: The unique identifier for a thinQ account

","urlObject":{"path":["account","{{account_id}}","product","origination","sms","settings","outbound"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"7f662852-6a1b-4048-a119-e3129ff3eb25","name":"Get Outbound Settings","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Basic {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/settings/outbound"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"deliveryConfirmationUrl\": \"{{deliveryConfirmationUrl}}\",\n \"deliveryNotificationType\": \"{{deliveryNotificationType}}\",\n \"id\": \"XX\",\n \"type\": \"account_sms_outbound_settings\"\n}"}],"_postman_id":"52a06738-8dab-49fa-9969-bd5c7e5381b1"},{"name":"Default DLR Settings","id":"e3307803-940e-440d-aed2-0c7ce9aea42e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","type":"text","value":"Basic {{token}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"settings\":\n {\n \"deliveryConfirmationUrl\": \"{{deliveryConfirmationUrl}}\",\n \"deliveryNotificationType\": \"{{deliveryNotificationType}}\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/settings/outbound","description":"

Update Default DLR Settings

\n\n

Delivery settings are a group of settings that affect the outbound flow of SMS messages. This endpoint allows you to update the settings tied to your account.

\n\n

Settings

\n\n

Delivery Notification URL

\n\n

An account level value that is the URL where all incoming delivery notifications will be forwarded.

\n\n

Delivery Notification Type

\n\n

Assign the format of incoming delivery notification payloads. Messages can be JSON or standard form POSTs. Supported values are \"json\" and \"form-data\".

\n\n

Incoming URL Parameters

\n\n

account_id: The unique identifier for a thinQ account

","urlObject":{"path":["account","{{account_id}}","product","origination","sms","settings","outbound"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"33f892ba-1f3f-4c25-a958-32e5e9d3b623","name":"Update Outbound Settings","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Basic {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"settings\":\n {\n \"deliveryConfirmationUrl\": \"{{deliveryConfirmationUrl}}\"\n }\n}"},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/settings/outbound"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"deliveryConfirmationUrl\": \"{{deliveryConfirmationUrl}}\",\n \"deliveryNotificationType\": \"{{deliveryNotificationType}}\",\n \"id\": \"XX\",\n \"type\": \"account_sms_outbound_settings\"\n}"}],"_postman_id":"e3307803-940e-440d-aed2-0c7ce9aea42e"},{"name":"Add Custom DLR Settings to a number","id":"1f78e9bb-155d-4881-9ff6-44b41f985e68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"dids\": [\r\n 1234567890,\r\n 1234567891\r\n ],\r\n \"dlrSettingsId\": 123,\r\n \"type\": \"did\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.thinq.com/inbound/number-management/delivery-settings","description":"

Use this endpoint to add a Custom DLR Setting to a number. Type can be either: did, hostedDid or shortcode, depending on the numbers that require the configuration. If you wish to unnasign the current settings, the value of dlrSettingsId must be null

Custom DLR settings, are a group of settings that can be assigned to a number modifying the outbound flow of SMS.

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/ip/{{ip}}","description":"

This will create a new IP Address for SMS\n*Must be a valid public IP address

\n","urlObject":{"path":["account","{{account_id}}","product","origination","sms","ip","{{ip}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"38b78391-7e37-4521-b3b5-daecf16ad05b","name":"Create New IP Address","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/ip/{{ip}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"assigned_IPs\": [\n {\n \"id\": \"XX.XX.XX.XX\",\n \"type\": \"account_sms_ip\"\n }\n ]\n}"}],"_postman_id":"8398d854-87cd-458c-b5e4-e1ed17b51013"},{"name":"List Existing IP Addresses","event":[{"listen":"test","script":{"id":"332f5524-29cb-48e6-8f61-223c3d2a5405","type":"text/javascript","exec":["","","pm.test(\"Rows Returned\", function () {"," var jsonData = pm.response.json();"," console.log(jsonData.rows[0]);"," "," pm.environment.set(\"selected_did\", JSON.stringify(jsonData.rows[0]));"," //pm.expect(jsonData.value).to.eql(100);","});","","",""]}}],"id":"e991677c-5a0d-402a-98ca-03079702f31b","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/ip?page=1&rows=1","description":"

This will list all existing IP addresses for an account. Default amount returned is 25.

\n","urlObject":{"path":["account","{{account_id}}","product","origination","sms","ip"],"host":["https://api.thinq.com"],"query":[{"key":"page","value":"1"},{"key":"rows","value":"1"}],"variable":[]}},"response":[{"id":"a8ca5ba5-695b-4d19-b471-767b6a01d83a","name":"List Existing IP Addresses","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/ip?page=1&rows=1","host":["https://api.thinq.com"],"path":["account","{{account_id}}","product","origination","sms","ip"],"query":[{"key":"page","value":"1"},{"key":"rows","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"total_rows\": 2,\n \"has_next_page\": true,\n \"page\": 1,\n \"rows_per_page\": 1,\n \"rows\": [\n {\n \"ip\": \"XX.XX.XX.XX\"\n }\n ]\n}"}],"_postman_id":"e991677c-5a0d-402a-98ca-03079702f31b"},{"name":"Create New IP Range","event":[{"listen":"test","script":{"id":"332f5524-29cb-48e6-8f61-223c3d2a5405","type":"text/javascript","exec":["","","pm.test(\"Rows Returned\", function () {"," var jsonData = pm.response.json();"," console.log(jsonData.rows[0]);"," "," pm.environment.set(\"selected_did\", JSON.stringify(jsonData.rows[0]));"," //pm.expect(jsonData.value).to.eql(100);","});","","",""]}}],"id":"135dfad5-df92-49a3-9a27-e96dfcff5e50","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/ip/{{123.123.123.[123-125]}}","description":"

This will create a range of IP address with one POST call. The format is below.\n*Must be valid public IP addresses

The fourth octet may be a range of addresses. Separate the start and end IP with a hyphen, and surround with square brackets.\ni.e: 123.123.123.[123-125] regex: /^[(\\d{1,3})-(\\d{1,3})]$/

\n","urlObject":{"path":["account","{{account_id}}","product","origination","sms","ip","{{123.123.123.[123-125]}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"394717c3-1c2f-40f7-bb7f-68bfec1d0d55","name":"Create New IP Range","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/ip/{{123.123.123.[123-125]}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"assigned_IPs\": [\n \"123.123.123.123\",\n \"123.123.123.124\",\n \"123.123.123.125\"\n ]\n}\n"}],"_postman_id":"135dfad5-df92-49a3-9a27-e96dfcff5e50"},{"name":"Update Existing IP Address","event":[{"listen":"test","script":{"id":"50914fbf-b21f-4be6-832a-3801f04d1a7e","type":"text/javascript","exec":["","",""]}}],"id":"4a248555-caf6-428b-bec5-dd19bb5f75f9","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/ip/{{oldIP}}/newIP/{{newIP}}","description":"

Update an existing SMS IP address.
*Must be valid public IP addresses

\n","urlObject":{"path":["account","{{account_id}}","product","origination","sms","ip","{{oldIP}}","newIP","{{newIP}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"5e47b054-9907-4cea-9540-57a8f9315ff6","name":"Update Existing IP Address","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/ip/{{oldIP}}/newIP/{{newIP}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"200 http code"}],"_postman_id":"4a248555-caf6-428b-bec5-dd19bb5f75f9"},{"name":"Delete Existing IP Address","event":[{"listen":"test","script":{"id":"332f5524-29cb-48e6-8f61-223c3d2a5405","type":"text/javascript","exec":["","","pm.test(\"Rows Returned\", function () {"," var jsonData = pm.response.json();"," console.log(jsonData.rows[0]);"," "," pm.environment.set(\"selected_did\", JSON.stringify(jsonData.rows[0]));"," //pm.expect(jsonData.value).to.eql(100);","});","","",""]}}],"id":"a9840aee-028e-4ed4-9440-29816c1761a2","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/origination/sms/ip/{ip}","description":"

Delete an existing IP address

\n","urlObject":{"path":["account","{{account_id}}","product","origination","origination","sms","ip","{ip}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"129b36ca-68d2-4068-aa04-aeaca24fb956","name":"Delete Existing IP Address","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/ip/{{ip}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"200 http code"}],"_postman_id":"a9840aee-028e-4ed4-9440-29816c1761a2"}],"id":"079295d8-e7e1-40ce-af01-c7db74aadf4c","_postman_id":"079295d8-e7e1-40ce-af01-c7db74aadf4c","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"10DLC Campaign Registration","item":[],"id":"0828df37-5e55-4c63-adc1-3aa2c862194e","description":"

Commio is directly connected to The Campaign Registry, which is the central hub for registering A2P 10LC messaging campaigns. You can use our platform for registering brands and campaigns, which will then pass them along directly to The Campaign Registry for review and sharing with the DCA (Direct Connect Aggregator) which is connected to the MNO (Mobile Network Operator) Gateway to transmit the messages.

For accessing our APIs for creating and registering brands and campaigns, as well as assigning numbers to campaigns, click here: https://api.thinq.com/campaign-registry/v1/documentation/

\n","_postman_id":"0828df37-5e55-4c63-adc1-3aa2c862194e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Toll Free Verification","item":[{"name":"Submit toll free verification for a toll free number","id":"00e835bf-2746-4d4d-8cdc-7b4d7209fe70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"businessStreetAddress\": \"124 W Main St.\",\n \"businessStreetAddress2\": \"Office 1234\",\n \"businessCity\": \"New York City\",\n \"businessStateProvinceRegion\": \"NY\",\n \"businessPostalCode\": \"10001\",\n \"businessCountry\": \"US\",\n \"businessContactFirstName\": \"John\",\n \"businessContactLastName\": \"Smith\",\n \"businessContactEmail\": \"email@example.com\",\n \"businessContactPhone\": \"2120000000\",\n \"businessName\": \"Example Business\",\n \"businessWebsite\": \"www.example.com\",\n \"useCaseCategories\": \"TWO_FACTOR_VERIFICATION\",\n \"useCaseSummary\": \"To be used to implement two factor authentication at example.com\",\n \"productionMessageSample\": \"Your example 2FA code is: EXAMPLE\",\n \"optInImageUrls\": \"https://www.example.com/cat.jpg,https://www.example.com/cat2.jpg\",\n \"optInType\": \"MOBILE_QR_CODE\",\n \"messageVolume\": \"10,000\",\n \"agreesToTerms\": \"YES\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.thinq.com/inbound/messaging/toll-free/verification/{{did}}","description":"

Submit toll free verification for a toll free number

To retrieve acceptable values for your account for the useCaseCategories, optInTypes, and messageVolume properties, you must make a GET request to /inbound/messaging/toll-free/verification/enum/:enum for each property.

\n","urlObject":{"path":["inbound","messaging","toll-free","verification","{{did}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"43c393ed-398a-4553-bcac-c1c25f8f9b05","name":"Default Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"businessStreetAddress\": \"124 W Main St.\",\n \"businessStreetAddress2\": \"Office 1234\",\n \"businessCity\": \"New York City\",\n \"businessStateProvinceRegion\": \"NY\",\n \"businessPostalCode\": \"10001\",\n \"businessCountry\": \"US\",\n \"businessContactFirstName\": \"John\",\n \"businessContactLastName\": \"Smith\",\n \"businessContactEmail\": \"email@example.com\",\n \"businessContactPhone\": \"2120000000\",\n \"businessName\": \"Example Business\",\n \"businessWebsite\": \"www.example.com\",\n \"useCaseCategories\": \"TWO_FACTOR_VERIFICATION\",\n \"useCaseSummary\": \"To be used to implement two factor authentication at example.com\",\n \"productionMessageSample\": \"Your example 2FA code is: EXAMPLE\",\n \"optInImageUrls\": \"https://www.example.com/cat.jpg,https://www.example.com/cat2.jpg\",\n \"optInType\": \"MOBILE_QR_CODE\",\n \"messageVolume\": \"10,000\",\n \"agreesToTerms\": \"YES\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.thinq.com/inbound/messaging/toll-free/verification/{{did}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Successfully submitted Toll Free Verification\""}],"_postman_id":"00e835bf-2746-4d4d-8cdc-7b4d7209fe70"},{"name":"Toll Free Verification status","id":"9dd4d2ab-cc85-44e9-9f93-1558a432f46f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://api.thinq.com/inbound/messaging/toll-free/verification/{{did}}","description":"

Look up a Toll Free Verification status and error description (if applicable) for a given DID.

Use this endpoint to retrieve valid values for use in the Toll Free Verification Submit endpoint.

Options for enumName for get TF Verification enum, options are optInTypes, messageVolume, useCaseCategories

The values returned for each type are acceptable values for their respective properties in the body of the Submit toll free verification endpoint.

Available values : optInTypes, messageVolume, useCaseCategories

\n","urlObject":{"path":["inbound","messaging","toll-free","verification","enum","{{enumName}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"c3a927c7-9a08-4e26-968a-4f46ec83b21b","name":"Default Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"https://api.thinq.com/inbound/messaging/toll-free/verification/{{enumName}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 0,\n \"message\": \"string\",\n \"data\": [\n \"string\"\n ]\n}"}],"_postman_id":"26132e62-f996-4027-af5a-39e2a1084321"}],"id":"c47b5817-f3ef-4891-b725-2805a6231bfb","_postman_id":"c47b5817-f3ef-4891-b725-2805a6231bfb","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Text Messaging","item":[{"name":"Sending SMS Messages","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","type":"text/javascript","exec":["",""]}}],"id":"e73eb37e-be32-4e07-84cf-75b5775f3853","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from_did\": \"9198900000\",\n \"to_did\": \"2125551234\",\n \"message\": \"Text Message Body\"\n}"},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/send","description":"

You can use the token created in the Configure Send Token section to use this resource.

You can use 10DLC, TF or Short Codes as the source or destination number.

\n","urlObject":{"path":["account","{{account_id}}","product","origination","sms","send"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"3e7fa414-48fe-411d-8e70-7dcff27d531f","name":"Sending SMS Messages","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from_did\": \"9198900000\",\n \"to_did\": \"2125551234\",\n \"message\": \"Text Message Body\"\n}"},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"guid\": \"JASI1901QIW\"\n}"}],"_postman_id":"e73eb37e-be32-4e07-84cf-75b5775f3853"},{"name":"Sending MMS via File Upload","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript"}}],"id":"e600f355-ce32-4330-ac01-ec3e3d572389","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"from_did","value":"NPANXXXXXX","sessionValue":"NPANXXXXXX","description":"

Source DID

\n","type":"text"},{"key":"to_did","value":"NPANXXXXXX","sessionValue":"NPANXXXXXX","description":"

Destination DID

\n","type":"text"},{"key":"file","sessionValue":null,"description":"

Binary Attachment

\n","type":"file","value":null},{"key":"message","value":"Optional text","description":"

Optional text content

\n","type":"text"}]},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/mms/send","description":"

You can use the token created in the Configure Send Token section to use this resource.

You can use 10DLC, TF or Short Codes as the source or destination number.

\n","urlObject":{"path":["account","{{account_id}}","product","origination","mms","send"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"4d8a2511-7ae5-4b47-a52a-6f521596c3f2","name":"Sending MMS Messages","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"formdata","formdata":[{"key":"from_did","value":"NPANXXXXXX","sessionValue":"NPANXXXXXX","description":"Source DID","type":"text"},{"key":"to_did","value":"NPANXXXXXX","sessionValue":"NPANXXXXXX","description":"Destination DID","type":"text"},{"key":"file","sessionValue":null,"description":"Binary Attachment","type":"file","value":""},{"key":"message","value":"Optional text","description":"Optional text content","type":"text"}]},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/mms/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"guid\":\"73e58146-99ba-11e8-a267-005056852c0d\"}"}],"_postman_id":"e600f355-ce32-4330-ac01-ec3e3d572389"},{"name":"Sending MMS via Media URL","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript"}}],"id":"bf32ff03-fbd4-4916-9bb8-552c1366f9fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"from_did","value":"NPANXXXXXX","sessionValue":"NPANXXXXXX","description":"

Source DID

\n","type":"text"},{"key":"to_did","value":"NPANXXXXXX","sessionValue":"NPANXXXXXX","description":"

Destination DID

\n","type":"text"},{"key":"media_url","value":"http://yoururl.com/remote_binary_file.jpg","sessionValue":"http://yoururl.com/remote_binary_file.jpg","description":"

Link to a binary file on your website

\n","type":"text"},{"key":"message","value":"Optional text","description":"

Optional text content

\n","type":"text"}]},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/mms/send","description":"

You can use the token created in the Configure Send Token section to use this resource.

You can use 10DLC, TF or Short Codes as the source or destination number.

\n","urlObject":{"path":["account","{{account_id}}","product","origination","mms","send"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"4acefc68-eebd-40f9-9630-512c1d8b6395","name":"Sending MMS Messages","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"formdata","formdata":[{"key":"from_did","value":"NPANXXXXXX","sessionValue":"NPANXXXXXX","description":"Source DID","type":"text"},{"key":"to_did","value":"NPANXXXXXX","sessionValue":"NPANXXXXXX","description":"Destination DID","type":"text"},{"key":"media_url","value":"http://customer_web_host.com/sms_endpoint.php","sessionValue":"http://","description":"URL to binary file on your webhost","type":"text"},{"key":"message","value":"Optional text","description":"Optional text content","type":"text"}]},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/mms/send"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\"guid\":\"73e58146-99ba-11e8-a267-005056852c0d\"}"}],"_postman_id":"bf32ff03-fbd4-4916-9bb8-552c1366f9fd"},{"name":"Receive SMS/MMS Messages","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"9c5ae132-fc3c-44c6-85a0-cd08fa66f720","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"VIEW","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"User-Agent","value":"thinq-sms"},{"key":"X-sms-guid","value":"*thinq SMS Guid"},{"key":"x-Attempt","value":"1"},{"key":"x-Commio-Signature","value":"377oEN/kFcppFD//1JCIvKpkxfU="}],"body":{"mode":"raw","raw":""},"url":"http://customer_url.com/message_forwarding_url","description":"

Receiving Inbound SMS/MMS Messages

\n\n

Incoming messages are received by our system and are forwarded to your servers. You will need to have a message forwarding url configured in order to support incoming messages.

\n\n

Configuring Message Forwarding URLs

\n\n

Configure an account level value in the \"Default Message Forwarding URL\" section. This is where all incoming messages will be forwarded if you do not configure a DID-level override.

\n\n

You can override the default URL for individual DIDs by using an \"SMS Routing Profile\". Once you have the routing profile configured, you can assign it to a DID in one of two ways:

\n\n

Choose the SMS Routing Profile in DID configuration on the Number Management page
Use the Origination API to assign profiles via the \"Create Feature Order\" process for DIDs

\n\n

Inbound Messages

\n\n

If a message is longer than 160 characters in 7-bit encoding, 140 bytes in 8-bit encoding, or 70 characters in UCS-2 encoding, it will be split

\n\n

Incoming Form Fields

\n\n

SMS:

from: Source DID
to: Destination DID
type: sms
message: Content of the message

\n\n

MMS:

from: Source DID
to: Destination DID
type: mms
message: URL or base64 representation of the media attachment, depending on your settings
contentType: A string indicating the MIME type of the file on the MMS message

MMS - Single Webhook:

from: Source DID
to: Destination DID
type: MMS
message: Text component of the MMS
attachments: Array of media attachments, either URLs or base64 representations, depending on your settings
contentType: An array of strings indicating the MIME type of the file on the MMS message. The content type for a given attachment is in the same positional order as the attachment is in the attachments array.

You can change the MMS attachment style on your inbound message settings.

Format of Message Field

\n\n

The content of the \"message\" field will vary based on the message type and how your inbound URL is configured.

\n\n

SMS: Standard text message
MMS with URL attachments: URL(s) of the binary attachment on a remote host
MMS with Binary attachments: Base 64 encoded version of the binary attachment(s)

","urlObject":{"protocol":"http","path":["message_forwarding_url"],"host":["customer_url","com"],"query":[],"variable":[]}},"response":[{"id":"f9cf5b92-f3ec-4ecc-8000-ac34d36dbe63","name":"Receive SMS/MMS Messages","originalRequest":{"method":"VIEW","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token","disabled":true},{"key":"Content-Type","value":"application/json","disabled":true}],"body":{"mode":"raw","raw":""},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"User-Agent","value":"thinq-sms","description":""},{"key":"X-sms-guid","value":"002eb8a5-db92-4c96-b410-8476a35a2346","description":""},{"key":"x-Attempt","value":"1","description":""},{"key":"x-Commio-Signature","value":"293oEN/kFcppFD//1JCIvKpkxfU=","description":""}],"cookie":[],"responseTime":null,"body":"SMS:\n from=9198900000\n to=2125551234\n type=sms\n message=Text+Message+Body\n\nMMS (Single webhook, URL attachments):\n from=9198900000\n to=2125551234\n type=mms\n message=MMS+text+here\n attachments[0]=https://storage.googleapis.com/hermes-mms/339fda2e-608c-11ef.jpg\n contentType[0]=image/jpg\n\nMMS (Single webhook, Base64 attachments):\n from=9198900000\n to=2125551234\n type=mms\n message=MMS+text+here\n attachments[0]=4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAA\n contentType[0]=image/png\n\nMMS (Separate webhooks, URL attachments):\n Message 1:\n from=9198900000\n to=2125551234\n type=mms\n message=MMS+text+here\n\n Message 2:\n from=9198900000\n to=2125551234\n type=mms\n message=https://storage.googleapis.com/hermes-mms/339fda2e-608c-11ef.gif\n contentType=image/gif\n\nMMS (Separate webhooks, Base64 attachments):\n Message 1:\n from=9198900000\n to=2125551234\n type=mms\n message=MMS+text+here\n\n Message 2:\n from=9198900000\n to=2125551234\n type=mms\n message=4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAA\n contentType=image/jpg\n\n"}],"_postman_id":"9c5ae132-fc3c-44c6-85a0-cd08fa66f720"},{"name":"Receive SMS Delivery Notifications","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":[""],"type":"text/javascript"}}],"id":"68b88acd-7556-4fbb-a599-784843f3ac02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"VIEW","header":[{"key":"useragent","value":"thinq-sms","type":"text"}],"body":{"mode":"raw","raw":""},"url":"http://customer_url.com/message_forwarding_url","description":"

Receiving Delivery Notification for Outbound SMS/MMS Messages

\n\n

Delivery Confirmation URL

\n\n

Configure an account level value in the \"Outbound SMS Configuration\" section. This is where all incoming delivery notifications will be forwarded .

\n\n

Delivery Notification Type

\n\n

Incoming delivery notifications can be forwarded as either JSON payloads or form POSTs. You configured option will determine the inbound format.

\n\n

Incoming Form POST

\n\n

guid: thinQ guid returned when an outbound message is sent via our API
\n
account_id: Your thinQ account ID
\n
source_did: Source DID
\n
destination_did: Destination DID
\n
timestamp: Time the delivery notification was received
\n
send_status: User friendly version of the status (i.e.: delivered)
\n
status: System version of the status (i.e.: DELIVRD)
\n
error: Error code if any (i.e.: 000)
\n

Incoming JSON

\n\n

{\n  \"guid\": \"3ccdaa4c-1996-xxxx-xxxx-xxxxxxx\",\n  \"account_id\": \"xxxxx\",\n  \"source_did\": \"9198900000\",\n  \"destination_did\": \"9198900000\",\n  \"timestamp\": \"2023-05-18T21:59:28.000Z\",\n  \"send_status\": \"delivered\",\n  \"status\": \"DELIVRD\",\n  \"error\": \"000\"\n}\n\n

Possible Status/Error Code Combinations

100 / SENT - The message was sent off to the carrier for delivery.
\n
110 / ACCEPTD - The carrier has acknowledged the message was received.
\n
000 / DELIVRD - The message has been delivered to the destination number.
\n
003 / EXPIRED - The message timed out in the carrier's system before delivery could be attempted.
\n
004 / DELETED - The carrier deleted the message prior to delivery.
\n
005 / UNDELIV - The carrier was unable to deliver the message to the destination number.
\n
007 / UNKNOWN - Unknown error
\n
REJECTED Status Codes:
\n
- 900 / Carrier Disabled - This destination carrier is disabled on your account.
  \n
- 800 / Carrier Blocked - The message was blocked by a mobile carrier.
  \n
- 700 / Opt Out Filtered - The destination number has opted out of receiving messages using a STOP keyword.
  \n
- 600 / Unregistered Traffic - The source number is not registered to a campaign.
  \n
\n

Test DLR webhook

You can recieve a test DLR webhook by sending an SMS/MMS to one of the following numbers, depending on the type of DLR you would like to recieve. This will perform all the normal checks but will not send the SMS and will not incur any charges. The webhook will be sent to the DLR endpoint configured on your sending number, or your account default if a number specific endpoint is not set.

9195550000 - Delivered
\n
9195555555 - Undelivered
\n

This API works for sending messages to 1 single recipient. Please use the messaging API for sending to multiple recipients: https://apidocs.thinq.com/#320caee1-da7f-43d8-822d-0288b29f9f2c

\n","_postman_id":"e4b3552a-b6af-42ff-ba23-2be2a25ed970","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Message Logs","item":[{"name":"Archive download","item":[{"name":"Get list of available years","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"4318a3e4-f0ae-4f94-b19a-c5b642b2a7c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/messaging/mdrs/download","description":"

Provides a list of all years with at least one day of MDRs available for download.

\n","urlObject":{"path":["messaging","mdrs","download"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"88d9fc91-447b-4843-b67a-e6bb0e3de238","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/messaging/mdrs/download"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\"2021\",\"2022\",\"2023\",\"2024\"]"}],"_postman_id":"4318a3e4-f0ae-4f94-b19a-c5b642b2a7c7"},{"name":"Get list of available months","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"eb05d1bb-94ca-4766-af7a-c7b08898c9b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/messaging/mdrs/download/{{year}}","description":"

Provides a list of all months within the given year with at least one day of MDRs available for download.

\n","urlObject":{"path":["messaging","mdrs","download","{{year}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"8c59d90f-267f-4ac4-9b10-d30366400ca3","name":"Example for a given year","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/messaging/mdrs/download/{{year}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\"01\",\"02\",\"03\",\"04\",\"06\",\"07\",\"08\",\"09\",\"10\",\"11\",\"12\"]"}],"_postman_id":"eb05d1bb-94ca-4766-af7a-c7b08898c9b0"},{"name":"Get list of available days","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"059361a1-c403-499a-8c6f-cc111783b3fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/messaging/mdrs/download/{{year}}/{{month}}","description":"

Provides a list of all days within the given year and month with at least one day of MDRs available for download.

\n","urlObject":{"path":["messaging","mdrs","download","{{year}}","{{month}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"94ebc51e-249b-4fe9-867f-c8e54e6d90db","name":"Example for a given year and month","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/messaging/mdrs/download/{{year}}/{{month}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\"06\",\"07\",\"08\",\"11\",\"13\",\"20\",\"21\",\"22\",\"25\"]"}],"_postman_id":"059361a1-c403-499a-8c6f-cc111783b3fa"},{"name":"Download MDRs for a given date","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"079de154-7b31-4a94-b3c2-0a15a342cb0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/messaging/mdrs/download/{{year}}/{{month}}/{{day}}","description":"

Returns the URL for downloading the GZipped CSV file containing all MDRs for the given date. This URL is only valid for one minute: a GET request to that URL has to be done within one ominute, otherwise the download won't be available.

\n","urlObject":{"path":["messaging","mdrs","download","{{year}}","{{month}}","{{day}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"59388432-0e7a-4acd-9664-3286318f3dc4","name":"Example for a given year and month","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/messaging/mdrs/download/{{year}}/{{month}}/{{day}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"downloadLink\": \"https://storage.googleapis.com/mdrs/123/2015/10/2015-10-21_mdr_123.csv.gz?signature=abc\"\n}"}],"_postman_id":"079de154-7b31-4a94-b3c2-0a15a342cb0c"}],"id":"2027ef16-b640-4fe0-a405-6a84774e4848","description":"

This group of resources is intended for discovering every date with available MDRs and providing a download link for a GZipped CSV file containing all MDRs for each date.

\n","_postman_id":"2027ef16-b640-4fe0-a405-6a84774e4848","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Message Detail Records (MDRs)","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript","packages":{}}}],"id":"6ccbcf6b-64ce-4845-b08f-54a66f49608e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.thinq.com/inbound/mdrs?currentPage=1&rowsPerPage=500","description":"

You can update the search criteria to include the following: fromDate, toDate, fromDid, toDid, groupId, succeeded, deliveryUID. This method allows only for searching and downloading within the last 90 days. In order to download MDRs older than 90 days, and/or a GZipped CSV file for any date, use the MDRs Archive download resource.

Example with search criteria:

https://api.thinq.com/inbound/mdrs?currentPage=1&rowsPerPage=500&resultCount=500&fromDate=2023-07-24T18:01:37.931Z&toDate=2023-07-31T18:01:37.931Z

Upcoming 8/24

The following fields will be added to the results: mms, carrier, total_surcharge

\n","urlObject":{"path":["inbound","mdrs"],"host":["https://api.thinq.com"],"query":[{"key":"currentPage","value":"1"},{"key":"rowsPerPage","value":"500"}],"variable":[]}},"response":[{"id":"03e7d291-3d29-44f1-bfb5-9bec9117ae8a","name":"Message Detail Records (MDRs)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.thinq.com/inbound/mdrs?currentPage=1&rowsPerPage=500","host":["https://api.thinq.com"],"path":["inbound","mdrs"],"query":[{"key":"currentPage","value":"1"},{"key":"rowsPerPage","value":"500"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"account_id\": \"12345\",\n \"from_did\": \"15125556726\",\n \"from_lata\": \"553\",\n \"from_ocn\": \"004F\",\n \"from_rc\": \"AUSTIN\",\n \"from_thinq_tier\": \"\",\n \"from_carrier_tier\": \"\",\n \"from_account_id\": \"\",\n \"to_did\": \"12175558240\",\n \"to_lata\": \"333\",\n \"to_ocn\": \"063E\",\n \"to_rc\": \"WEST DANA\",\n \"to_thinq_tier\": \"0\",\n \"to_carrier_tier\": \"0\",\n \"to_account_id\": \"\",\n \"tollfree\": \"0\",\n \"delivery_status_code\": \"200\",\n \"delivery_uid\": \"ad3d007a-2fcb-11ee-ad42-34553484e26\",\n \"retail\": \"0\",\n \"total_retail\": \"0\",\n \"msg_count\": \"1\",\n \"msg_length\": \"30\",\n \"direction\": \"inbound\",\n \"created\": \"2023-07-31T17:57:12.000Z\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"campaign_id\": \"\"\n }\n ],\n \"totalRows\": 3,\n \"rowsPerPage\": 500,\n \"hasPrevPage\": false,\n \"hasNextPage\": false,\n \"currentPage\": 1,\n \"totalPages\": 1,\n \"downloadUID\": \"366ea41b-42d6-4f14-a49a-bfe1235saaa14\"\n}"}],"_postman_id":"6ccbcf6b-64ce-4845-b08f-54a66f49608e"},{"name":"Download MDRs","event":[{"listen":"test","script":{"id":"5726757e-8a7a-45a1-92bb-c5e5d77676fd","exec":["",""],"type":"text/javascript"}}],"id":"561ddf59-eb99-4655-81f5-0b7bf70ef2e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"

Your authentication string is a base64 encoded version of username:token

\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/inbound/mdrs/download/{{ID}}","description":"

Obtain the downloadUID from the Get Message Detail Records API call, and then use that ID to download the actual file.

Upcoming 8/24

The following fields will be added to the MDRs file: mms, carrier, total_surcharge.

\n","urlObject":{"path":["inbound","mdrs","download","{{ID}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"7cee7e26-e270-4c6b-b044-03372d1f1faf","name":"Download MDRs","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/inbound/mdrs/download/{{ID}}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"account_id,from_did,from_lata,from_ocn,from_rc,from_thinq_tier,from_carrier_tier,from_account_id,to_did,to_lata,to_ocn,to_rc,to_thinq_tier,to_carrier_tier,to_account_id,tollfree,delivery_status_code,delivery_uid,retail,total_retail,msg_count,msg_length,direction,created,group_id,campaign_id\nXX,XXXXXXXXXX,426,779F,CARY-RTP,1,0,XX,XXXXXXXXXX,426,779F,CARY-RTP,1,0,10,0,200,a2b45c9e-e0e3-11e7-9dbb-f45c898ef579,0.0035,0.0035,1,15,outbound,2023-08-01 15:29:56,Group1,CX1234\nXX,XXXXXXXXXX,426,779F,CARY-RTP,1,0,XX,XXXXXXXXXX,426,779F,CARY-RTP,1,0,10,0,200,1f80cba8-e0e5-11e7-8870-f45c898ef579,0.0035,0.0035,1,15,outbound,2023-08-01 15:40:36"}],"_postman_id":"561ddf59-eb99-4655-81f5-0b7bf70ef2e7"},{"name":"Get SMS Status","event":[{"listen":"test","script":{"id":"332f5524-29cb-48e6-8f61-223c3d2a5405","exec":["","","pm.test(\"Rows Returned\", function () {"," var jsonData = pm.response.json();"," console.log(jsonData.rows[0]);"," "," pm.environment.set(\"selected_did\", JSON.stringify(jsonData.rows[0]));"," //pm.expect(jsonData.value).to.eql(100);","});","","",""],"type":"text/javascript"}}],"id":"546bdfd6-e910-4ed0-ae5c-9ee4bdf053cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic {{token}} "},{"key":"Content-Type","value":"application/json"}],"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/{{message_id}}","description":"

Get SMS Status

Retrieve detailed status of a message by message id.

The SENT status will be assigned to messages when they are forwarded on from our system. Subsequent statuses are provided as a best effort but depend on many circumstances beyond our control. Not all carriers provide any additional feedback regarding messaging success.

Returned Fields

id: Message GUID
\n
account_id: Your thinQ account ID
\n
characters_amount: Number of characters in the SMS
\n
delivery_notifications: Array of delivery notification objects
\n
- error: Provider error code
  \n
- send_status: Provider human readable send status
  \n
- status: Provider status code
  \n
- timestamp: Delivery notification time stamp
  \n
\n
from: DID the message was sent from
\n
to: DID the message was setnt to
\n
inbound: True or false indicating whether the message was inbound or outbound respectively
\n
mms: True or false indicating whether the message was an MMS or not
\n
sent_at: UTC Timestamp of when the message was sent
\n
tries: Array of logs indicating each failed attempt to forward the message to the customer
\n
- timestamp: Unix timestamp of the forwarding attempt
  \n
  - code: Record of the failure code retrieved from the forward url
    \n
  - message: Failure message retrieved from the forward url
    \n
  - type: Internal type of failure
    \n
  - uid: UID for the log
    \n
  - url: The forwarding URL that was attempted
    \n
  \n
\n

Possible Status/Error Code Combinations

\n\n

100 / SENT - The message was sent off to the carrier for delivery.
\n
110 / ACCEPTD - The carrier has acknowledged the message was received.
\n
000 / DELIVRD - The message has been delivered to the destination number.
\n
003 / EXPIRED - The message timed out in the carrier's system before delivery could be attempted.
\n
004 / DELETED - The carrier deleted the message prior to delivery.
\n
005 / UNDELIV - The carrier was unable to deliver the message to the destination number.
\n
007 / UNKNOWN - Unknown error
\n
REJECTED Status Codes:
\n
- 900 / Carrier Disabled - This destination carrier is disabled on your account.
  \n
- 800 / Carrier Blocked - The message was blocked by a mobile carrier.
  \n
- 700 / Opt Out Filtered - The destination number has opted out of receiving messages using a STOP keyword.
  \n
- 600 / Unregistered Traffic - The source number is not registered to a campaign.
  \n
\n

\n","urlObject":{"path":["account","{{account_id}}","product","origination","sms","{{message_id}}"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"f137b7a3-5973-48bb-ba27-d7b4e14d4feb","name":"Get SMS Status","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{auth_string}}","description":"Your authentication string is a base64 encoded version of username:token"}],"body":{"mode":"raw","raw":""},"url":"https://api.thinq.com/account/{{account_id}}/product/origination/sms/url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"a75573fe-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"account_id\": \"xxx\",\n \"characters_amount\": 17,\n \"delivery_notifications\": [\n {\n \"timestamp\": 1692883512,\n \"send_status\": \"sent\",\n \"status\": \"SENT\",\n \"error\": 100\n },\n {\n \"timestamp\": 1692883512,\n \"send_status\": \"delivered\",\n \"status\": \"DELIVRD\",\n \"error\": \"000\",\n }\n ],\n \"from\": \"984XXXXXXX\",\n \"to\": \"336XXXXXXX\",\n \"inbound\": false,\n \"mms\": false,\n \"a2p\": true,\n \"sent_at\": \"2023-08-24T13:25:12Z\",\n \"tries\": []\n}"}],"_postman_id":"546bdfd6-e910-4ed0-ae5c-9ee4bdf053cd"}],"id":"59ef2a85-2480-4076-9240-968e395dfbf1","_postman_id":"59ef2a85-2480-4076-9240-968e395dfbf1","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}}],"id":"a820489e-e145-4399-953f-1499a07e1bb5","description":"

Before sending SMS messages please make sure that at least one of your DIDs has the feature activated and for 10DLC numbers, they must be assigned to a Campaign and Toll Free numbers must be Verified. You can activate SMS by signing in to https://commio.io

To activate DIDs go to Configure Numbers. You may edit a single one by clicking on the Edit Icon (shaped like a pencil). If you want to bulk add SMS, just select more than one DID by clicking on it (or \"Select All\") and highlighting them gray. A Pencil icon will appear above the number management table. If you click on it a \"Bulk Edit\" pop-up will appear. Check the SMS checkbox, slide the button to the green position and click on the \"Set\" button.

You can get the \"account_id\" and \"user_id\" values that you'll need to make API requests from the \"Profile\" \"User Profile\" tab in https://commio.io

\n\n

Messaging Limits by Source DID

\n\n

Tollfree DIDs

\n\n

40 messages per second

\n\n

Regular DIDs

\n\n

1 message per second
900 messages per hour
3000 messages per day
200 verbatim messages per hour

\n\n

SMS FAQ

\n\n

For MMS support, do you have guidelines on how a multi-part mime body should be formatted before base64 encoding it (for MMS with text and image etc)When sending a multi-part message from a mobile device our carrier actually splits the content into two separate messages that are sent and billed individually. For consistency, we recommend sending from customer applications in the same fashion. One outbound SMS message with text content, and one outbound MMS message with base64 encoded binary content.
For MMS is there a maximum message payload?Maximum payload for MMS messages is 5MB.
For MMS what header fields are supported?The thinQ messaging system does not currently analyze or forward specific headers. Support for this feature may be added in a future release.
For SMS/MMS the SMPP protocol and MM4 both have the concept of delivery confirmations. Are delivery confirmations part of the service offering? You may set up a URL to receive delivery notifications in the portal or via our API under the folder \"Message Settings\".
Is messaging to short codes supported? Yes, the API accepts short codes as destination numbers.
If a MMS is sent to me and I reject it (non 200ok response), is that billable? Rejections are handled as failures, so they will be retried until the system eventually gives up. You will be billed for this transaction, because we will already have been billed by our carrier at that point. Further details are included in the next question.
If a Message is sent to me and I send back an error, is there a retry or does the message just fail? Will the far end receive a notification that it failed? An initial submission attempt will be retried four additional times in the event of a failure. The initial timeout is set for ten seconds, and ten additional seconds are added for each subsequent attempt. After the fifth failure we consider the message undeliverable. We do not trigger a followup message to the original sender to indicate that a failure was encountered.
How do you all handle message segments. For example say I send you 400 characters of text for an sms, do you guys break that message up and bill appropriately?
A maximum of 910 characters can be sent in a text message, but they will be chunked into segments and billed accordingly.
- Maximum of 160 characters for a single message.
- Larger messages are broken into 152 byte segments to account for control characters. For example, if a message is 161 ASCII characters, it's sent as an 152 chars message plus an 9 chars message (7 bytes are used for sending the concatenation info).
- Sending emojis and/or non-ascii characters will cause the character set to be changed and your messages to be split into 70 character chunks.
- Any character in the set |, ^, €, {, }, [, ], \\ counts as two bytes, meaning a single message containing one of them is limitted to 159 characters, two to 158 and so on.

\n\n

Send a Test SMS Message

\n\n

You can use the token created in theGetting Startedsection to use this resource.

\n\n

Simply populate the fields using a valid account id, along with the associated token information.
Enter DID information and submit.
There are a couple rules to keep in mind:

\n\n

From DID must be ported through your Commio account
Token must be associated with the username you enter
Token must have SMS Status set to \"Send\" in the portal

\n\n

The user interface for sending messages is here:Send a Test SMS Message

\n\n

Send a Test MMS Message

\n\n

You can use the token created in theGetting Startedsection to use this resource.

\n\n

Simply populate the fields using a valid account id, along with the associated token information.
Enter DID information, select a binary file, and submit.
There are a couple rules to keep in mind:

\n\n

From DID must be ported through your Commio account
The MMS protocol does not support sending from toll free numbers
Token must be associated with the username you enter
Token must have SMS Status set to \"Send\" in the portal

\n\n

The user interface for sending messages is here:Send a Test MMS Message

","event":[{"listen":"prerequest","script":{"id":"4d725f3b-6352-49aa-9df1-5d13896e946d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eec2f33d-6c13-4385-8418-33351b8468cf","type":"text/javascript","exec":[""]}}],"_postman_id":"a820489e-e145-4399-953f-1499a07e1bb5","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Hosted Numbers","item":[{"name":"Get paginated hosted numbers associated with the logged in user's account","id":"0a292a19-d036-4b0c-a11d-db6743aae0d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.thinq.com/inbound/hosted-numbers?rowsPerPage=25¤tPage=1","description":"

Get paginated hosted numbers associated with the logged in user's account

(Required)

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

(Required)

\n","type":"text/plain"},"key":"currentPage","value":"1"}],"variable":[]}},"response":[{"id":"096decd6-6637-4303-b0fd-51e4b97b7539","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/hosted-numbers?rowsPerPage=25¤tPage=1","host":["{{baseUrl}}"],"path":["hosted-numbers"],"query":[{"key":"rowsPerPage","value":"25"},{"key":"currentPage","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 9123457899,\n \"sms\": {\n \"enabled\": true,\n \"status\": \"provisioned\"\n }\n },\n {\n \"id\": 9123457899,\n \"sms\": {\n \"enabled\": true,\n \"status\": \"provisioned\"\n }\n }\n ],\n \"totalRows\": 1,\n \"rowsPerPage\": 25,\n \"hasPrevPage\": false,\n \"hasNextPage\": true,\n \"currentPage\": 1,\n \"totalPages\": 1\n}"}],"_postman_id":"0a292a19-d036-4b0c-a11d-db6743aae0d0"},{"name":"Step 1 - Upload CSV file of numbers","id":"7db99261-0c01-4cb6-9785-bd2bbf292cfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"file\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.thinq.com/inbound/hosted-numbers/fileUpload","description":"

Create a hosted numbers order by submitting a CSV file of phone numbers, with each phone number on a new line.

Create a hosted numbers order by submitting an array of phone numbers.

Complete a hosted numbers order by providing your contact information, including a signature.

orderId - the order ID returned from inbound/hosted-numbers/fileUpload
signature - a Base64 encoded image of your signature

Delete a hosted number by id

(Required)

\n","type":"text/plain"},"type":"any","value":"19152057032","key":"id"}]}},"response":[{"id":"e8c6201b-0a63-4b4c-a53e-f20ad1876622","name":"response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"url":{"raw":"{{baseUrl}}/hosted-numbers/:id","host":["{{baseUrl}}"],"path":["hosted-numbers",":id"],"variable":[{"key":"id","value":"19152057032","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1\n },\n \"statusCode\": 200,\n \"message\": \"Success!\"\n}"}],"_postman_id":"a1f6f7ce-ff5f-48d4-b01d-a4f779da2be8"},{"name":"Bulk Delete hosted numbers","id":"5a490e86-c2bc-4261-953b-e76d089ff300","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"hostedNumbers\": [\n 19195551234,\n 19195554321\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.thinq.com/inbound/hosted-numbers/bulkrelease","description":"

Delete a batch of hosted numbers

Associate an Inbound Msg URL to a hosted number

You can bring 10DLC and/or Toll Free numbers to the Commio platform for the purpose of text messaging. A signed LOA is required in order to use hosted messaging on the Commio platform.

\n","_postman_id":"02968de5-b26b-477a-8f48-5e9cb198b782","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}},{"name":"Groups","item":[{"name":"Add Group","id":"5d14ccb2-f547-4a87-b822-9422b80ab310","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"groupName\": \"New group name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.thinq.com/account/groups","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}},"urlObject":{"path":["account","groups"],"host":["https://api.thinq.com"],"query":[],"variable":[]}},"response":[{"id":"8d83113f-0a42-4a0a-bbdf-bc3eda7627dc","name":"example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"groupName\": \"New group name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.thinq.com/account/groups"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Group with id 22 added successfully!.\",\n \"data\": {\n \"cas\": \"1681927458490351616\",\n \"value\": 22\n }\n}"}],"_postman_id":"5d14ccb2-f547-4a87-b822-9422b80ab310"},{"name":"Assigning groups to numbers","id":"0d6b117e-0cec-427e-b478-95ee6e949340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"dids\": [\n 12053013549,\n 17042997676\n ],\n \"groupId\": 20,\n \"hosted\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.thinq.com/inbound/number-management/groups","description":"

Associate a group to one or more phone numbers, non-hosted or hosted

Unassociate a group from one or more phone numbers, non-hosted or hosted

Webhook Type options

TF_VERIFICATION_RESULT
\n
- Mock Webhook data sent to supplied URL:
  { \"did\": \"12120000000\", \"status\": \"mock-status\", \"reason\": \"MOCK_REASON\", \"description\": \"Mock description for the reason\" }
\n
SMS_PROVISIONING
\n
- Mock webhook data sent to supplied URL:
  { \"did\": \"19876543210\", \"status\": \"MOCK_STATUS\" }
\n
SMS_OPTOUT_CONFIRMATION
\n
- Mock webhook data sent to supplied URL:
  { \"to\": 19875553210, \"from\": 12125551234, \"message\": \"Mock optout message\", \"guid\": \"MOCK1234567ABC\", \"timestamp\": 1735689600 }
\n
CAMPAIGN_NUMBER_ASSIGNMENT_STATUS
\n
- Mock webhook data sent to supplied URL:
  { \"did\": \"19876543210\", \"campaignId\": \"C123456\", \"status\": \"MOCK_STATUS\", \"description\": \"Mock description for the status\" }
  \n
- status values: 'PENDING' | 'ADDED' | 'FAILED' | 'DELETED' | 'DELETE_FAILED'
  \n
\n
CAMPAIGN_DCA_STATUS_UPDATES
\n
- Mock webhook data sent to supplied URL:
  { \"campaignId\": \"C123456\", \"brandId\": \"B123456\", \"dcaStatus\": \"MOCK_STATUS\", \"description\": \"Mock description for the status\" }
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

dcaStatus Value	Description
CAMPAIGN_SHARE_ADD	The campaign was officially created with The Campaign Registry and is awaiting the vetting process.
CAMPAIGN_SHARE_ACCEPT	The upstream DCA has accepted the campaign details via the vetting process, but the campaign is still waiting for final MNO activation.
CAMPAIGN_SHARE_DELETE	The upstream DCA has declined the campaign details via the vetting process and requires additional information to be provided about the campaign.
PENDING_MNO_ACTIVATION	The campaign is waiting for MNO Activation. Numbers are not able to be assigned to the campaign yet.
MNO_ACTIVATED	The campaign has been deployed by all MNOs and is now activated. Numbers can now be assigned to the campaign.

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}},"urlObject":{"path":["webhooks","mock",":webhookType"],"host":["https://api.thinq.com"],"query":[],"variable":[{"type":"any","value":null,"key":"webhookType"}]}},"response":[{"id":"88b71531-a2ee-451e-881a-f8f1537f0c4e","name":"Mock Webhook","originalRequest":{"method":"GET","header":[],"url":"https://api.thinq.com/webhooks/mock/TF_VERIFICATION_RESULTS"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"We will attempt to send a TF_VERIFICATION_RESULTS webhook to the subscribed endpoint based on your settings in https://commio.io/#/webhooks.\"\n}"}],"_postman_id":"01d26d57-521e-41b1-a8b3-394b0d498ff4"},{"name":"Verify Webhooks","id":"10384cde-dd0f-4ac8-bc48-35f18c0fc627","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"url":"","description":"

How to verify the Commio X-Commio-Signature header

Canonicalize the body of the request; this is a standard to create crypto canonicalization based on RFC8785: https://datatracker.ietf.org/doc/html/rfc8785
\n
- There are code packages which can help with this. A Javascript example is found here: https://www.npmjs.com/package/canonicalize
\n
Join the canonicalized JSON body as a string to the end of the url
\n
- Example: 'https://example.com/webhoook{a:\"first\",b:\"second\",c:\"third\"}'
\n
Create a HMAC-SHA1 using your secret webhook token, add the joined URL and body from step 2, and convert it into base64
\n
- Example: createHmac('sha1', secretToken).update('https://example.com/webhoook{a:\"first\",b:\"second\",c:\"third\"}').digest('base64')
\n
Compare the hmac created in step 3 with the x-Commio-Signature header pulled from the request headers.
\n

Parsing x-www-urlencoded

In some cases such as DLRs and inbound messages, you have the option to receive webhooks from Commio as x-www-urlencoded. In these cases, you should use the URLEncoded standard where all properties are treated as strings. One example of a parser that will be compatible is https://www.npmjs.com/package/qs. The rest of the validation process is the same as application/json.

Inbound messaging

For inbound messages, we will EXCLUDE the \"attachments\" field when generating the signature. When verifying inbound messaging webhooks, please exclude the attachments field and content. The rest of the validation process is the same.

Below is a complete code example in Typescript. You will have to do something similar in your language of choice.

import { canonicalize } from 'json-canonicalize';\nimport { createHmac } from 'crypto';\nconst signatureHeader = \"UJ5ge3cte8zO+yr6l89EedHJsuE=\";\nconst webhookToken = \"b4396659cc6b1aa16458a51bb55704205257eeee1b2e31d5425e39af0f191b85\";\nconst validate = (url: string, webhookToken: string, request: { body: Record<string, any>, headers: Record<string, string> }) => {\n    const webhookEndpoint = url; // This is where we are sending the webhook as a full address\n    const key = webhookToken; // This is the secret token we use to sign the x-Commio-Signature header\n    const { body } = request;\n    const canonicalJSONBody = canonicalize(body); // Order the body in alphabetical order, this is using an npm package but you could do it yourself\n    console.log(canonicalJSONBody); // Logs: {\"bTestTwo\":456,\"zTestOne\":123} (Note how the order of these is now alphabetical)\n    const stringToSign = webhookEndpoint + canonicalJSONBody; // join the endpoint with the JSON body\n    console.log(stringToSign); // Logs: https://webhook.site/aba979a0-9c4d-43ee-af61-24df6f578c9f{\"bTestTwo\":456,\"zTestOne\":123}\n    const hmac = createHmac('sha1', key) // create a sha1 Hmac using your webhookToken\n        .update(stringToSign) // This is the url + JSON body from above\n        .digest('base64'); // Base64 encode the result\n    console.log(hmac); // Logs: UJ5ge3cte8zO+yr6l89EedHJsuE=\n    const header = request.headers['x-commio-signature']; // Pull the x-commio-signature from the request headers\n    console.log(header); // Logs: UJ5ge3cte8zO+yr6l89EedHJsuE= (Note how this matches the hmac above, so this request is good)\n    if (header !== hmac) { // if these don't match, the request wasn't from Commio\n        // reject or handle how you choose\n    }\n    else {\n        // The header and the hmac you generated are identical, the webhook is verified\n    }\n}\nvalidate('https://webhook.site/aba979a0-9c4d-43ee-af61-24df6f578c9f', webhookToken, {\n    body: {\n        \"zTestOne\": 123,\n        \"bTestTwo\": 456\n    },\n    headers: {\n        \"x-commio-signature\": signatureHeader\n    }\n});\n\n

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"10384cde-dd0f-4ac8-bc48-35f18c0fc627"},{"name":"Webhook Secret","id":"149acf7d-7c0b-41c7-9e19-8ae9333b1609","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.thinq.com/webhooks/token","description":"

Get your webhook token secret

Refresh your webhook token. This will remove your existing token and return a new one for use in verification.

Commio Webhooks

For certain events within the Commio platform, Commio will send a webhook to a supplied URL. You can subscribe to most events by going to https://commio.io/#/webhooks and creating a webhook subscription entry with a specified URL.

Commio webhooks will generally be a POST application/json request. The following headers will be supplied:

X-Commio-Signature: A unique hash which combines your webhook secret token with the body of the request to verify webhooks come from Commio.
X-Attempt: the number of the current attempt made for this specific webhook already, 1 if it is the first.

In certain cases, webhooks will be a GET application/form-encoded request. This would be in the case of DLRs or Incoming Messages

The data being sent in webhooks will generally vary by webhook event type. Making a request to https://api.thinq.com/accounts/webhooks/mock/:webhookType will provide a mock webhook with the expected data for each webhookType.

We expect our customers to respond with a 200 OK. In the event we do not receive a 200 OK, the retry schedule is as follows:

The timeout for each attempt is 1 second times the number of the attempt. For example, if we are on the third attempt of the webhook, we will wait 3 seconds for a response before marking it as a time-out.
\n
Everything other than a 2XX HTTP response code is considered a failure in deliverying the webhook.
\n
We will make a first retry after 16 seconds of the first failure, and our next retries will be after 64, 256, 1024, 4096 and 16384 seconds (this is approximately 1, 5, 17, 68 and 273 minutes) after each subsequent failure. Retries will cease after the sixth failure.
\n

All Commio webhooks will come from the following IP address: 192.81.236.250

If your network is behind a firewall, you will have to whitelist the above IP address in order for us to reach your endpoint.

\n","_postman_id":"d98109f1-6def-4350-a981-3644f1830d42","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","id":"c575e410-8aeb-4ac5-9390-ae2b20766c95","name":"Commio API Documentation","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"d3d40c3b-2b59-476a-926d-ad77d36450b1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c8631c8d-c1c5-40df-acfc-cc4c8cf4551e","type":"text/javascript","exec":[""]}}],"variable":[{"id":"6234430c-647e-491a-be8f-900e10ccadcf","key":"host","value":"https://api.thinq.com","type":"string"}]}

Authentication

Pagination:

Activating DIDs - Step-by-Step

Receiving Inbound SMS/MMS Messages

Configuring Message Forwarding URLs

Inbound Messages

Incoming Form Fields

Format of Message Field

Receiving Inbound SMS/MMS Messages

Configuring Message Forwarding URLs

Inbound Messages

Incoming Form Fields

Format of Message Field

Receiving Inbound RCS Messages

Configuring Inbound Message Forwarding URLs

Inbound RCS Messages

Incoming Form Fields

Format of rcs Field

form-urlencoded Format

Receiving Delivery Notification for Outbound RCS Messages

Delivery Confirmation URL

Incoming Form POST

Incoming JSON

Possible Status/Error Code Combinations

Test DLR webhook

Receiving Read Receipts for Outbound RCS Messages

Read Receipts URL

Incoming Form POST

Incoming JSON and example

Get Default DLR Settings

Settings

Delivery Confirmation URL

Delivery Notification Type

Incoming URL Parameters

Update Default DLR Settings

Settings

Delivery Notification URL

Delivery Notification Type

Incoming URL Parameters

Receiving Inbound SMS/MMS Messages

Configuring Message Forwarding URLs

Inbound Messages

Incoming Form Fields

Format of Message Field

Receiving Delivery Notification for Outbound SMS/MMS Messages

Delivery Confirmation URL

Delivery Notification Type

Incoming Form POST

Incoming JSON

Possible Status/Error Code Combinations

Test DLR webhook

Upcoming 8/24

Upcoming 8/24

Get SMS Status

Returned Fields

Possible Status/Error Code Combinations

Messaging Limits by Source DID

Tollfree DIDs

Regular DIDs

SMS FAQ

Send a Test SMS Message

Send a Test MMS Message

Webhook Type options

How to verify the Commio X-Commio-Signature header

Parsing x-www-urlencoded

Inbound messaging

Commio Webhooks

Format of `rcs` Field