A strange and simple interface for managing your business communications resources on Voxbone's network.
\nOperating global business communications and managing rapid changes in demands is a challenging task. That's why our APIs are designed to make this process as flexible and straightforward as possible.
\nThis is an interactive documentation intended to help guide developers on our API interface and allow simple and easy testing right here, in the browser. When you select an endpoint, the machine column will be expanded, displaying possible URI parameters, request and response schemas and examples.
\nThe endpoint can be tested with \"Switch to Console\" option, a simple editor to form your test API request, specify URI parameters or request bodies. The only thing you would need to add is an Authorization header with your basic authentication information. Optionally, you can specify it for one request and pin to make it global as you test.
Voxbone doesn't offer official SDKs for its APIs, but the swagger definition of the endpoints can be downloaded and used to build auto-generated SDKs in many different programming languages.
\nWe are actively developing powerful, agile and scalable APIs to unlock new functionality and improve the efficiency of your Voice and SMS communications.
\nIf you would like to join our early access programme please contact us.
\nAuthentication against the Voxbone API is done with API keys. In order to use Voxbone's APIs, please ensure:
\nThere are currently two environments for our platform's APIs:
\napi.voxbone.com base url. Interacts with your live and actual resources on Voxbone platform.api.sandbox.voxbone.com base url. Intended for simulating ordering and address verification specifically. You can test ordering without being charged, service activation and more. Any API calls performed through our Sandbox API can be viewed via our Sandbox Portal.For protecting both your apps and our systems, a 20 requests per second by client IP is performed on your API calls. If you send more requests to Voxbone API endpoints, your requests may be rejected by an HTTP 509 Bandwidth Limit Exceeded or HTTP 429 Too Many Requests in the response.
If there's an error with processing your API request, the server will return a proper HTTP status, along with error types and codes.
\nStandard errors related to validation of your request in terms of data and field types. These would indicate a problem with your request.
\nHow to fix : Please review the endpoint description to fix any errors.
\nErrors in the API workflows related to regulations. These would indicate something missing or not allowed for your request.
\nHow to fix : Review regulatory requirements for the service activation in your request (i.e. address requirements on the country, number type, etc.). Common fixes include formatting/absence of extraFields
After a created address is submitted for verification, our customer success team perform checks to verify the relationship between the address/id information and proof documents if any.
\nHow to fix : This means a change in the address information or the proof documents is necessary to proceed with service activation. If you have any disputes or confusion about what to do next, feel free to raise a support ticket from our Portal.
\nWhen a request to apply a list of configurations to numbers, the request might be rejected due to some errors in the request or related to the account status.
\nAuthentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"}],"url":"/v1/inventory/country?pageNumber=0&pageSize=20","urlObject":{"path":["v1","inventory","country"],"host":[""],"query":[{"disabled":true,"description":{"content":"The country code for the DID in its ISO 3166-1 alpha-3 format (e.g. 'GBR' for United Kingdom, 'USA' for United States of America, 'BEL' for Belgium, and special code 'WLD' for iNum numbers).
\n","type":"text/plain"},"key":"countryCodeA3","value":"The type of DIDs (service) offered for the country.
\n","type":"text/plain"},"key":"didType","value":"The page number, starting at 0.
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"The page size (max number of entities that are displayed in the response).
\n","type":"text/plain"},"key":"pageSize","value":"20"}],"variable":[]}},"response":[{"id":"3acb1924-9f13-4e68-a1f3-c7ce5beda8da","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/v1/inventory/country?pageNumber=0&pageSize=20","host":[""],"path":["v1","inventory","country"],"query":[{"key":"countryCodeA3","value":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/inventory/country/:countryCodeA3","urlObject":{"path":["v1","inventory","country",":countryCodeA3"],"host":[""],"query":[],"variable":[{"description":{"content":"The three letter identifier of the country.
\n","type":"text/plain"},"type":"string","value":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/inventory/country/:countryCodeA3/state","urlObject":{"path":["v1","inventory","country",":countryCodeA3","state"],"host":[""],"query":[],"variable":[{"description":{"content":"It indicates the country code of the country in its ISO 3166-1 alpha-3 format. Note that only countryCodeA3 for countries that have states are valid values.
\n","type":"text/plain"},"type":"string","value":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/inventory/didgroup?countryCodeA3=Indicates the country code of the DID group in its ISO 3166-1 alpha-3 format (e.g. 'GBR' for United Kingdom, 'USA' for United States of America, 'BEL' for Belgium, etc.).
\n","type":"text/plain"},"key":"countryCodeA3","value":"Can be used if you want information about specific DID groups. Note that you can specify multiple ids by repeating the query parameter.
\n","type":"text/plain"},"key":"didGroupIds","value":"The numerical identifier for the didGroup's state. Please see the listState operation to retrieve a valid state identifier.
\n","type":"text/plain"},"key":"stateId","value":"A string pattern to be matched the city name. The entered string will be searched within any part of the city name.
\n","type":"text/plain"},"key":"cityNamePattern","value":"The rate center can be defined as a zone (which can be equivalent to a city or the area of a city) e.g. the rate center of 'NEW YORK CITY ZONE 1' would be 'NWYRCYZN01'. The rate center is a notion usually used in north America.
\n","type":"text/plain"},"key":"rateCenter","value":"The area code of the DID group (e.g. '646').
\n","type":"text/plain"},"key":"areaCode","value":"The type of DID.
\n","type":"text/plain"},"key":"didType","value":"Set to true if you want to show the didGroups with no stock currently available.
\n","type":"text/plain"},"key":"showEmpty","value":"Can be used if you want to list DID groups that support certain features such as VoxSMS or VoxFAX. (eg. 6 for VoxFAX, 25 for VoxSMS, 50 for Voice). Note that you can specify multiple features by repeating the query parameter.
\n","type":"text/plain"},"key":"featureIds","value":"The page number, starting at 0.
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"The page size (max number of entities that are displayed in the response).
\n","type":"text/plain"},"key":"pageSize","value":"20"}],"variable":[]}},"response":[{"id":"2376a53e-f019-4627-a619-7072254b7722","name":"200 - Coverage in USA, New York","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"","description":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under [Account Settings](https://www.voxbone.com/portal/account-settings?tab=apiPassword). Please use our [API quickstart guide](https://support.voxbone.com/hc/en-us/articles/202774042-Getting-Started-with-APIs) for more help.\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/v1/inventory/didgroup?countryCodeA3=USA&didGroupIds=174&stateId=32&cityNamePattern=NEW YORK&areaCode=646&didType=GEOGRAPHIC&showEmpty=false&featureIds=29&pageNumber=0&pageSize=20","host":[""],"path":["v1","inventory","didgroup"],"query":[{"key":"countryCodeA3","value":"USA","description":"Indicates the country code of the DID group in its ISO 3166-1 alpha-3 format (e.g. 'GBR' for United Kingdom, 'USA' for United States of America, 'BEL' for Belgium, etc.)."},{"key":"didGroupIds","value":"174","description":"Can be used if you want information about specific DID groups. Note that you can specify multiple ids by repeating the query parameter."},{"key":"stateId","value":"32","description":"The numerical identifier for the didGroup's state. Please see the listState operation to retrieve a valid state identifier."},{"key":"cityNamePattern","value":"NEW YORK","description":"A string pattern to be matched the city name. The entered string will be searched within any part of the city name."},{"key":"rateCenter","value":"","description":"The rate center can be defined as a zone (which can be equivalent to a city or the area of a city) e.g. the rate center of 'NEW YORK CITY ZONE 1' would be 'NWYRCYZN01'. The rate center is a notion usually used in north America.","disabled":true},{"key":"areaCode","value":"646","description":"The area code of the DID group (e.g. '646')."},{"key":"didType","value":"GEOGRAPHIC","description":"The type of DID."},{"key":"showEmpty","value":"false","description":"Set to true if you want to show the didGroups with no stock currently available."},{"key":"featureIds","value":"29","description":"Can be used if you want to list DID groups that support certain features such as VoxSMS or VoxFAX. (eg. 6 for VoxFAX, 25 for VoxSMS, 50 for Voice). Note that you can specify multiple features by repeating the query parameter."},{"key":"pageNumber","value":"0","description":"The page number, starting at 0."},{"key":"pageSize","value":"20","description":"The page size (max number of entities that are displayed in the response)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Date","value":"Thu, 28 May 2020 17:13:34 GMT"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains;"}],"cookie":[],"responseTime":null,"body":"{\n \"didGroups\": [\n {\n \"didGroupId\": 174,\n \"countryCodeA3\": \"USA\",\n \"stateId\": 32,\n \"didType\": \"GEOGRAPHIC\",\n \"cityName\": \"NEW YORK CITY ZONE 01\",\n \"areaCode\": \"646\",\n \"rateCenter\": \"NWYRCYZN01\",\n \"stock\": 3105,\n \"setup100\": 0,\n \"monthly100\": 21,\n \"available\": true,\n \"regulationRequirement\": null,\n \"features\": [\n {\n \"featureId\": 6,\n \"name\": \"VoxFax\",\n \"description\": \"VoxFax\"\n },\n {\n \"featureId\": 50,\n \"name\": \"Voice\",\n \"description\": \"Voice\"\n },\n {\n \"featureId\": 51,\n \"name\": \"VoxOUT International\",\n \"description\": \"Used to build the coverage pages in the public website\"\n },\n {\n \"featureId\": 5,\n \"name\": \"T.38\",\n \"description\": \"T.38\"\n },\n {\n \"featureId\": 29,\n \"name\": \"VoxOUT Emergency\",\n \"description\": \"Feature that allows the VoxDID to access emergency services\"\n },\n {\n \"featureId\": 52,\n \"name\": \"VoxOUT National\",\n \"description\": \"Used to build the coverage pages in the public website\"\n },\n {\n \"featureId\": 25,\n \"name\": \"VoxSMS\",\n \"description\": \"VoxSMS\"\n }\n ]\n }\n ],\n \"resultCount\": 1\n}"},{"id":"63e9114c-af74-43a7-942d-c1350f847cc2","name":"200 - OK","originalRequest":{"method":"GET","header":[{"description":{"content":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under [Account Settings](https://www.voxbone.com/portal/account-settings?tab=apiPassword). Please use our [API quickstart guide](https://support.voxbone.com/hc/en-us/articles/202774042-Getting-Started-with-APIs) for more help.\n","type":"text/plain"},"key":"apikey","value":""},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/v1/inventory/didgroup?countryCodeA3=Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/inventory/country/:countryCodeA3/restriction","urlObject":{"path":["v1","inventory","country",":countryCodeA3","restriction"],"host":[""],"query":[],"variable":[{"description":{"content":"The country code for the DID in its ISO 3166-1 alpha-3 format (e.g. 'GBR' for United Kingdom, 'USA' for United States of America, 'BEL' for Belgium, etc.).
\n","type":"text/plain"},"type":"string","value":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/inventory/zone","urlObject":{"path":["v1","inventory","zone"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5ed84d0b-c585-4051-985a-612bc11d8664","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/inventory/zone"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"zone\": [\n \"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/inventory/feature","urlObject":{"path":["v1","inventory","feature"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"1cbacf53-36ab-4dca-a8c3-da70f4ec76bf","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/inventory/feature"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"features\": [\n {\n \"featureId\": \"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/ordering/cart?pageNumber=0&pageSize=20","urlObject":{"path":["v1","ordering","cart"],"host":[""],"query":[{"disabled":true,"description":{"content":"Identifies the cart and is returned by the createCart method or can be retrieved with the listCart method.
\n","type":"text/plain"},"key":"cartIdentifier","value":"The reference of the cart.
\n","type":"text/plain"},"key":"reference","value":"The page number, starting at 0.
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"The page size (max number of entities that are displayed in the response).
\n","type":"text/plain"},"key":"pageSize","value":"20"}],"variable":[]}},"response":[{"id":"0c976e9a-b40f-4c92-975c-c793b652ad9c","name":"200 - Find by cart identifier","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"","description":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under [Account Settings](https://www.voxbone.com/portal/account-settings?tab=apiPassword). Please use our [API quickstart guide](https://support.voxbone.com/hc/en-us/articles/202774042-Getting-Started-with-APIs) for more help.\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/v1/ordering/cart?cartIdentifier=3630217&pageNumber=0&pageSize=20","host":[""],"path":["v1","ordering","cart"],"query":[{"key":"cartIdentifier","value":"3630217","description":"Identifies the cart and is returned by the createCart method or can be retrieved with the listCart method."},{"key":"reference","value":"d87927aa-c121-4555-9d21-cc87691b8567","description":"The reference of the cart.","disabled":true},{"key":"pageNumber","value":"0","description":"The page number, starting at 0."},{"key":"pageSize","value":"20","description":"The page size (max number of entities that are displayed in the response)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Date","value":"Fri, 29 May 2020 11:24:29 GMT"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains;"}],"cookie":[],"responseTime":null,"body":"{\n \"carts\": [\n {\n \"cartIdentifier\": 3630217,\n \"customerReference\": \"d87927aa-c121-4555-9d21-cc87691b8567\",\n \"description\": \"GBR & Capacity\",\n \"dateAdded\": \"2019-11-22 16:47:22\",\n \"orderProducts\": [\n {\n \"orderProductId\": 4972421,\n \"productType\": \"DID\",\n \"productDescription\": \"[UNITED KINGDOM] ABERDEEN (1224)\",\n \"quantity\": 125,\n \"didgroupId\": 8826\n },\n {\n \"orderProductId\": 4954789,\n \"productType\": \"CAPACITY\",\n \"productDescription\": \"additional capacity VoxTrunk | Zone World\",\n \"quantity\": 10,\n \"didgroupId\": null\n }\n ]\n }\n ],\n \"resultCount\": 1\n}"},{"id":"7d997704-8c82-423b-903b-5178726e3a57","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/v1/ordering/cart?pageNumber=0&pageSize=20","host":[""],"path":["v1","ordering","cart"],"query":[{"key":"cartIdentifier","value":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/ordering/cart/:cartIdentifier","urlObject":{"path":["v1","ordering","cart",":cartIdentifier"],"host":[""],"query":[],"variable":[{"description":{"content":"Identifies the cart and is returned by the createCart method or can be retrieved with the listCart method.
\n","type":"text/plain"},"type":"string","value":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerReference\": \"The creation of a cart depends on your own business logic, but you'll always need to create at least one cart to place an order (checkoutCart). You can place multiple orders per cart or you can create separate carts for each order. Note that different product types (DID, Capacity or prepaid credits) can be added into one single cart.
\n","urlObject":{"path":["v1","ordering","cart"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"706d946b-5084-408b-8a22-914e93bc5272","name":"200 - OK","originalRequest":{"method":"PUT","header":[{"key":"apikey","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customerReference\": \"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cartIdentifier\": \"Only one product can be added per addToCart request. The system will automatically create a new orderProductId (or add the items to an existing one) for the items added to your cart. You can retrieve the orderProductId with the listCart method. When you order capacity you should update your capacity forecast (in the portal). The delivery of capacity is not in real-time and requires validation from our operation team.
\n","urlObject":{"path":["v1","ordering","cart",":cartIdentifier","product"],"host":[""],"query":[],"variable":[{"description":{"content":"Identifies the cart and is returned by the createCart method or can be retrieved with the listCart method.
\n","type":"text/plain"},"type":"string","value":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cartIdentifier\": \"Set quantity to 0 if you want to remove the product from the cart.
\n","urlObject":{"path":["v1","ordering","cart",":cartIdentifier","product",":orderProductId"],"host":[""],"query":[],"variable":[{"description":{"content":"The identifier of the cart.
\n","type":"text/plain"},"type":"string","value":"The identifier of the product.
\n","type":"text/plain"},"type":"string","value":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/ordering/cart/:cartIdentifier/checkout","description":"Allows you to checkout a cart and place an order for all the products contained in the cart. You can then retrieve your orders using the listOrder method.
\n","urlObject":{"path":["v1","ordering","cart",":cartIdentifier","checkout"],"host":[""],"query":[],"variable":[{"description":{"content":"The identifier of your cart which is formed of a fixed string such as 'apiv3:60677:' and an ID which is incremented each time a new cart is created.
\n","type":"text/plain"},"type":"string","value":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/ordering/cart/:cartIdentifier","urlObject":{"path":["v1","ordering","cart",":cartIdentifier"],"host":[""],"query":[],"variable":[{"description":{"content":"The identifier of the cart.
\n","type":"text/plain"},"type":"string","value":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/ordering/order?pageNumber=0&pageSize=20","urlObject":{"path":["v1","ordering","order"],"host":[""],"query":[{"disabled":true,"description":{"content":"The order reference.
\n","type":"text/plain"},"key":"reference","value":"The status of the order.
\n","type":"text/plain"},"key":"status","value":"The date from which you want to filter your listed orders based on the timestamp for the order's creation date (dateAdded) in the format YYYY-MM-DD HH:MM:SS
\n","type":"text/plain"},"key":"dateFrom","value":"The date until which you want to filter your listed orders based on the timestamp for the cart's creation date (dateAdded) in the format YYYY-MM-DD HH:MM:SS.
\n","type":"text/plain"},"key":"dateTo","value":"The page number, starting at 0.
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"The page size (max number of entities that are displayed in the response).
\n","type":"text/plain"},"key":"pageSize","value":"20"}],"variable":[]}},"response":[{"id":"495d6e63-8c17-498e-adc1-82602ee26c86","name":"200 - Filter by ordered date","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"","description":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under [Account Settings](https://www.voxbone.com/portal/account-settings?tab=apiPassword). Please use our [API quickstart guide](https://support.voxbone.com/hc/en-us/articles/202774042-Getting-Started-with-APIs) for more help.\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/v1/ordering/order?dateFrom=2020-05-29 12:00:00&dateTo=2020-05-29 13:00:00&pageNumber=0&pageSize=20","host":[""],"path":["v1","ordering","order"],"query":[{"key":"reference","value":"64594DS4992832","description":"The order reference.","disabled":true},{"key":"status","value":"FULFILLED","description":"The status of the order.","disabled":true},{"key":"dateFrom","value":"2020-05-29 12:00:00","description":"The date from which you want to filter your listed orders based on the timestamp for the order's creation date (dateAdded) in the format YYYY-MM-DD HH:MM:SS"},{"key":"dateTo","value":"2020-05-29 13:00:00","description":"The date until which you want to filter your listed orders based on the timestamp for the cart's creation date (dateAdded) in the format YYYY-MM-DD HH:MM:SS."},{"key":"pageNumber","value":"0","description":"The page number, starting at 0."},{"key":"pageSize","value":"20","description":"The page size (max number of entities that are displayed in the response)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Date","value":"Fri, 29 May 2020 12:31:59 GMT"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains;"}],"cookie":[],"responseTime":null,"body":"{\n \"orders\": [\n {\n \"orderId\": 4992826,\n \"reference\": \"64594DS4992826\",\n \"dateAdded\": \"2020-05-29 12:19:15\",\n \"dateCanceled\": null,\n \"status\": \"FULFILLED\",\n \"customerReference\": \"7c7c5c09-4db8-437a-8cd6-2682b4cc6712c\"\n },\n {\n \"orderId\": 4992829,\n \"reference\": \"64594CA4992829\",\n \"dateAdded\": \"2020-05-29 12:19:24\",\n \"dateCanceled\": null,\n \"status\": \"CONFIRMED\",\n \"customerReference\": \"fadc93ff-e39c-4876-8b44-860d60d7295d\"\n },\n {\n \"orderId\": 4992832,\n \"reference\": \"64594DS4992832\",\n \"dateAdded\": \"2020-05-29 12:21:58\",\n \"dateCanceled\": null,\n \"status\": \"FULFILLED\",\n \"customerReference\": \"99c37736-a61d-477d-81c0-94782f392bec\"\n }\n ],\n \"resultCount\": 3\n}"},{"id":"4d2b5a93-0558-4109-bd14-099168682474","name":"200 - List all orders placed","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"","description":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under [Account Settings](https://www.voxbone.com/portal/account-settings?tab=apiPassword). Please use our [API quickstart guide](https://support.voxbone.com/hc/en-us/articles/202774042-Getting-Started-with-APIs) for more help.\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/v1/ordering/order?pageNumber=0&pageSize=20","host":[""],"path":["v1","ordering","order"],"query":[{"key":"reference","value":"","description":"The order reference.","disabled":true},{"key":"status","value":"","description":"The status of the order.","disabled":true},{"key":"dateFrom","value":"","description":"The date from which you want to filter your listed orders based on the timestamp for the order's creation date (dateAdded) in the format YYYY-MM-DD HH:MM:SS","disabled":true},{"key":"dateTo","value":"","description":"The date until which you want to filter your listed orders based on the timestamp for the cart's creation date (dateAdded) in the format YYYY-MM-DD HH:MM:SS.","disabled":true},{"key":"pageNumber","value":"0","description":"The page number, starting at 0."},{"key":"pageSize","value":"20","description":"The page size (max number of entities that are displayed in the response)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Date","value":"Fri, 29 May 2020 12:24:08 GMT"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains;"}],"cookie":[],"responseTime":null,"body":"{\n \"orders\": [\n {\n \"orderId\": 4984705,\n \"reference\": \"64594DS4984705\",\n \"dateAdded\": \"2020-05-27 11:09:53\",\n \"dateCanceled\": \"2020-05-27 12:45:09\",\n \"status\": \"CANCELED\",\n \"customerReference\": \"DID orders\"\n },\n {\n \"orderId\": 4985309,\n \"reference\": \"64594DS4985309\",\n \"dateAdded\": \"2020-05-27 13:40:46\",\n \"dateCanceled\": null,\n \"status\": \"FULFILLED\",\n \"customerReference\": \"USA DIDs for #231\"\n },\n {\n \"orderId\": 4992826,\n \"reference\": \"64594DS4992826\",\n \"dateAdded\": \"2020-05-29 12:19:15\",\n \"dateCanceled\": null,\n \"status\": \"FULFILLED\",\n \"customerReference\": \"99c37736-a61d-477d-81c0-94782f392bec\"\n },\n {\n \"orderId\": 4992829,\n \"reference\": \"64594CA4992829\",\n \"dateAdded\": \"2020-05-29 12:19:24\",\n \"dateCanceled\": null,\n \"status\": \"CONFIRMED\",\n \"customerReference\": \"d8194475-7449-498a-9dab-fd3b03eec76d\"\n },\n {\n \"orderId\": 4992832,\n \"reference\": \"64594DS4992832\",\n \"dateAdded\": \"2020-05-29 12:21:58\",\n \"dateCanceled\": null,\n \"status\": \"FULFILLED\",\n \"customerReference\": \"fadc93ff-e39c-4876-8b44-860d60d7295d\"\n }\n ],\n \"resultCount\": 5\n}"},{"id":"afb7ddf2-ad38-42c0-80cf-5205b6620cb4","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/v1/ordering/order?pageNumber=0&pageSize=20","host":[""],"path":["v1","ordering","order"],"query":[{"key":"reference","value":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/ordering/accountbalance","urlObject":{"path":["v1","ordering","accountbalance"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"3c2d590d-bffe-4c4a-bf4a-3b75327c57eb","name":"200 - View account balance","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"","description":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under [Account Settings](https://www.voxbone.com/portal/account-settings?tab=apiPassword). Please use our [API quickstart guide](https://support.voxbone.com/hc/en-us/articles/202774042-Getting-Started-with-APIs) for more help.\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/ordering/accountbalance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Date","value":"Fri, 29 May 2020 12:10:44 GMT"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains;"}],"cookie":[],"responseTime":null,"body":"{\n \"accountBalance\": {\n \"balance\": 0,\n \"threshold\": 3,\n \"currency\": \"EUR\",\n \"active\": false\n }\n}"},{"id":"627cae61-4fd5-4c88-9603-85b28afb8eab","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/ordering/accountbalance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountBalance\": {\n \"balance\": \"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/inventory/creditpackage","urlObject":{"path":["v1","inventory","creditpackage"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"91684385-d9f2-4476-9940-6f9139e84ff4","name":"200 - List usage credits","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"","description":"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under [Account Settings](https://www.voxbone.com/portal/account-settings?tab=apiPassword). Please use our [API quickstart guide](https://support.voxbone.com/hc/en-us/articles/202774042-Getting-Started-with-APIs) for more help.\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/inventory/creditpackage"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Date","value":"Fri, 29 May 2020 12:12:47 GMT"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains;"}],"cookie":[],"responseTime":null,"body":"{\n \"creditPackages\": [\n {\n \"creditPackageId\": 1,\n \"name\": \"Usage Credits\",\n \"price100\": 10000\n }\n ]\n}"},{"id":"968bb099-8e33-423b-922c-af90b593723c","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/inventory/creditpackage"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"creditPackages\": [\n {\n \"creditPackageId\": \"Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/regulation/zipcode?countryCodeA3=For some DID Groups with an address=LOCAL requirement, the ListZipcodes returns no items. This indicates that the regulation is not strict about the Zipcode matching the local address and hence any valid zip code can be entered (it will not be checked).
\n","urlObject":{"path":["v1","regulation","zipcode"],"host":[""],"query":[{"disabled":true,"description":{"content":"This is the area code of the DID which can be retrieved using the listDidGroup or listDid methods. Since an area code can be the same for two different countries, the country should also be specified. If the whole list for a given country is needed, then you can leave the area code unspecified.
\n","type":"text/plain"},"key":"areaCode","value":"This is the country code A3 of the country for which the list of zip codes and cities is needed. In practice, the area code will also be needed to identify specifically which cities and zip codes are a match.
\n","type":"text/plain"},"key":"countryCodeA3","value":"The page number, starting at 0.
\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"The page size (max number of entities that are displayed in the response).
\n","type":"text/plain"},"key":"pageSize","value":"20"}],"variable":[]}},"response":[{"id":"41e04b50-5c18-4bb2-8c11-01eb0c6496df","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"apikey","value":""},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/v1/regulation/zipcode?countryCodeA3=Authentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
\n"},{"key":"Accept","value":"application/json","type":"text"}],"url":"/v1/regulation/address?pageNumber=0&pageSize=20","urlObject":{"path":["v1","regulation","address"],"host":[""],"query":[{"disabled":true,"description":{"content":"This is the ID of the regulation address which is returned by createRegulationAddress.
\n","type":"text/plain"},"key":"regulationAddressId","value":"Name of the company.
\n","type":"text/plain"},"key":"companyName","value":"First name of the customer.
\n","type":"text/plain"},"key":"firstName","value":"Last name of the customer.
\n","type":"text/plain"},"key":"lastName","value":"The three letter identifier for the address's country.
\n","type":"text/plain"},"key":"countryCodeA3","value":"The city for the address.
\n","type":"text/plain"},"key":"city","value":"The zip code for the address.
\n","type":"text/plain"},"key":"zipCode","value":"The street for the address.
\n","type":"text/plain"},"key":"streetName","value":"The building number for the address.
\n","type":"text/plain"},"key":"buildingNumber","value":"The reference for the customer.
\n","type":"text/plain"},"key":"customerReference","value":"