{"info":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","description":"

Authorisation

All API requests require authorisation. This can be one of two methods;

Bearer Token - This is the 'old' method, and widely supported. Simply send an Authorization: Bearer <token> header with your request using your API token.
\n
JWT Token - This may be preferred for some integrations. It is possible to use any Portal username/password to obtain a token for the API which is then send in header Authorization: Bearer <JWT> as above.
\n

Service Provider Selection

All API endpoints have the Base URI of https://api.apalo.io/v1 - most users will only have access to administer one Service Provider account so this is sufficient.

Where your token permits access to more than one Service Provider Account this should be added after the /v1 path, e.g. to manage SP310176000 you would use the Base URI of https://api.apalo.io/v1/310176000

Developers building integrations that may be expanded in the future, or where you anticipate managing multiple accounts, are free to use this extended format in all requests.

Conventions

Pagination

Some API endpoints support range selection intended to facilitate pagination, this is universally provided using the parameters limit and start. Endpoints that support this will return a count parameter in the response that indicates the total number of results that matched your query.

e.g. if you have 42 numbers on your account, and make a request with limit: 10 you will receive 10 numbers in the response, with count: 42. You could then make subsequent requests to iterate through the pages.

Sorting

Some API endpoints support sorting of the results returned. Where this is provided this is enabled using the sort parameter.

By default the sort is ascending, so sort=iccid would return a list of ICCIDs sorted numerically. This can be varied or specified either by prepending the parameter with a + (ascending sort) e.g. +name would sort by name A-Z or - (descending sort) e.g. -name would sort by name Z-A or alternatively by suffixing the parameter with :asc or :desc as appropriate (e.g. name:desc and -name are identical)

Multiple parameters can be specified by separating them by commas (e.g. -date,+name)

Date / Time

All dates and times are returned in the simplified version of ISO 8601 used by MySQL and other popular open source applications;

Dates take the form YYYY-MM-DD
Times take the form HH:mm:ss

This differs from ISO 8601 in that the ISO date 2021-02-23T21:00:00Z would be represented as 2021-02-23 21:00:00

Numbering

All telephone numbers are represented in E.164 format without any leading characters (e.g. +), i.e. a standard UK Geographic number would be 441632900123

All Mobile SIMs are referenced by their ICCID (the long SIM card number starting 8944)

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16075422","collectionId":"1a50de91-367a-4e01-bc8f-babdd69557af","publishedId":"TzY4eEDF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0b4fa3"},"publishDate":"2021-06-03T15:23:15.000Z"},"item":[{"name":"Utilities","item":[{"name":"Server Time","id":"339c7259-9f9e-46a2-8bd2-3a20594bc6e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/utils/time","description":"

Get the current server time (useful for testing availability)

These utilities are not specific to any account or Service Provider but are provided for general use and to test connectivity to the API.

\n","_postman_id":"c06b6a95-7c91-422f-90b4-ff7f7074a505","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}},{"name":"Numbering","item":[{"name":"Search Available Numbers","id":"f5cafa57-4229-478f-9acc-c29def944cb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"country\": \"44\",\n \"area\": \"141\",\n \"search\": \"*23*\",\n \"limit\": 2\n}","options":{"raw":{"language":"json"}}},"url":"https://api.apalo.io/v1/numbers/available/:country_code","description":"

Search for available numbers which can be allocated to your account.

Country is a required parameter, but currently only UK numbering (44) is available.

(Required) E164 Country Code (Currently only 44 Supported)

\n","type":"text/plain"},"type":"any","value":"44","key":"country_code"}]}},"response":[{"id":"7162feee-b567-4148-9e2f-6e4ff5d53883","name":"Search Available Numbers","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"country\": \"44\",\n \"area\": \"1632\",\n \"search\": \"*23*\",\n \"limit\": 2\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.apalo.io/v1/numbers/available/:country_code","host":["https://api.apalo.io/v1"],"path":["numbers","available",":country_code"],"query":[{"key":"","value":null,"type":"text","disabled":true}],"variable":[{"key":"country_code","value":"44","description":"(Required) E164 Country Code (Currently only 44 Supported)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 10:11:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"13485"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"111deffe18d7d93de18d100d8fc94a4b838def4e"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"number\": \"441632960231\",\n \"provider\": \"apalo\",\n \"external\": false,\n \"country\": \"44\",\n \"price\": {\n \"initial\": 0,\n \"recurring\": 0\n }\n },\n {\n \"number\": \"441632960234\",\n \"provider\": \"apalo\",\n \"external\": false,\n \"country\": \"44\",\n \"price\": {\n \"initial\": 0,\n \"recurring\": 0\n }\n }\n ]\n}"}],"_postman_id":"f5cafa57-4229-478f-9acc-c29def944cb8"},{"name":"Allocate New Number(s) - Apalo","id":"9efeecad-e39b-47eb-8f8e-ee3dda3ee76b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"numbers\": [\n \"441632900701\",\n \"441632900702\"\n ]\n}"},"url":"https://api.apalo.io/v1/numbers/allocate","description":"

Allocate new numbers from Apalo (retrieved using the Search Available Numbers function above) to your account.

Add numbers to the Apalo platform that you have obtained from another Communications Provider and directed to our SBCs.

This allows you to use existing numbers on the Apalo UC Platform without porting them to Apalo, they will appear within the platform like any other Apalo number.

The provider parameter is provided for your own reference, to allow you to keep track of where the number is obtained from, it is not used internally by Apalo.

Get a list of allocated numbers, or those assigned to a specific enterprise or carrying a specific label

Search for numbers containing specific digits, * is wildcard

\n","type":"text/plain"},"key":"search","value":"*1632900*"},{"description":{"content":"

If using pagination, the sequence number to start from

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

Limit number of results (use with Start to enable pagination)

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

Show only numbers from this CP (Use \"apalo\" to find only apalo provided numbers)

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

Search for numbers by enterprise, * is wildcard

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

Search for numbers by label, * is wildcard

\n","type":"text/plain"},"key":"label","value":""}],"variable":[]}},"response":[{"id":"34e76d83-c939-4bee-8009-e21abd4e4bc1","name":"Get Allocated Numbers","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.apalo.io/v1/numbers/allocated?search=*1632900*&start=0&limit=100&provider=apalo&enterprise=&label=","host":["https://api.apalo.io/v1"],"path":["numbers","allocated"],"query":[{"key":"search","value":"*1632900*","description":"Search for numbers containing specific digits, * is wildcard"},{"key":"start","value":"0","description":"If using pagination, the sequence number to start from"},{"key":"limit","value":"100","description":"Limit number of results (use with Start to enable pagination)"},{"key":"provider","value":"apalo","description":"Show only numbers from this CP (Use \"apalo\" to find only apalo provided numbers)"},{"key":"enterprise","value":"","description":"Search for numbers by enterprise, * is wildcard"},{"key":"label","value":"","description":"Search for numbers by label, * is wildcard"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 10:35:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"4ae417e9109ab82067f0adf02a801802a06bcb31"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"number\": \"441632900933\",\n \"provider\": \"apalo\",\n \"external\": false,\n \"country\": \"44\",\n \"label\": null,\n \"enterprise\": \"AcmeWidgets\"\n },\n {\n \"number\": \"441632900935\",\n \"provider\": \"apalo\",\n \"external\": false,\n \"country\": \"44\",\n \"label\": null,\n \"enterprise\": null\n }\n ],\n \"count\": 42\n}"}],"_postman_id":"cd8475e0-5b4e-495b-81a2-d3911272ac68"},{"name":"Get Number Detail","id":"180766f2-9739-44a4-afc2-9fcdf9afd5ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/numbers/allocated/:number","description":"

Get detailed information on an individual number

(Required) Number in E.164 format

\n","type":"text/plain"},"type":"any","value":"","key":"number"}]}},"response":[{"id":"fbb153c9-be7e-4157-bac0-25c93b01ec83","name":"Get Number Detail","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.apalo.io/v1/numbers/allocated/:number","host":["https://api.apalo.io/v1"],"path":["numbers","allocated",":number"],"variable":[{"key":"number","value":"441632900458","description":"(Required) Number in E.164 format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 10:36:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"60"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"9921fd26c98fc9abf38af22aa9c80b39cf77e57d"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"number\": \"441632900458\",\n \"provider\": \"apalo\",\n \"external\": false,\n \"country\": \"44\",\n \"label\": null,\n \"enterprise\": null\n }\n ]\n}"}],"_postman_id":"180766f2-9739-44a4-afc2-9fcdf9afd5ef"},{"name":"Configure Number","id":"64478d5b-473c-4e72-b409-ce7d3b7fc355","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"enterprise\": \"AcmeWidgets\",\n \"label\": \"AcmeMainNumbers\"\n}"},"url":"https://api.apalo.io/v1/numbers/allocated/:number","description":"

Configure an individual number.

At this time, there are only two parameters that can be altered - label (which can be used as a simple free sting label for this number, and enterprise which will assign a number to the given enterprise on the Apalo UC platform.

Number routing is configured within the UC Platform \"UserAdmin\" control panel only at present.

(Required) Number in E.164 format

\n","type":"text/plain"},"type":"any","value":"441632900458","key":"number"}]}},"response":[],"_postman_id":"64478d5b-473c-4e72-b409-ce7d3b7fc355"},{"name":"Delete Number","id":"0818737c-e538-4ee2-914a-a580c313cac7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.apalo.io/v1/numbers/allocated/:number","description":"

Delete the number from the Apalo platform.

If the number was provided by Apalo the number will be removed from service and placed in a quarantine period during which it cannot be reallocated to another subscriber.

If the number was added to the platform as external: true then the number can be re-added at any time.

(Required) Number in E.164 format

\n","type":"text/plain"},"type":"any","value":"441632900458","key":"number"}]}},"response":[],"_postman_id":"0818737c-e538-4ee2-914a-a580c313cac7"}],"id":"343e5940-0ddb-4f8a-b0d0-2199b30aa2d9","_postman_id":"343e5940-0ddb-4f8a-b0d0-2199b30aa2d9","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}},{"name":"Mobile SIMs","item":[{"name":"SIM Provisioning","item":[{"name":"Allocated SIMs","id":"1b2122f3-9e8f-43ed-932d-856c3e0498b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/sims/allocated?search=&start=0&limit=20&type=sip","description":"

Retrieve a list of allocated SIMs.

This will return all SIMs that have been activated, even if they have later been suspended or terminated.

This endpoint will not return SIMs that have not yet been activated.

If using pagination, the sequence number to start from

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

Limit number of results (use with Start to enable pagination)

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

Optionally one of mno, fmc, sip to limit to SIMs of this type

\n","type":"text/plain"},"key":"type","value":"sip"}],"variable":[]}},"response":[{"id":"f72442d4-1c28-4cc3-a7a2-1029bbe0e6e2","name":"Allocated SIMs","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.apalo.io/v1/sims/allocated?search=&start=0&limit=20&type=sip","host":["https://api.apalo.io/v1"],"path":["sims","allocated"],"query":[{"key":"search","value":""},{"key":"start","value":"0","description":"If using pagination, the sequence number to start from"},{"key":"limit","value":"20","description":"Limit number of results (use with Start to enable pagination)"},{"key":"type","value":"sip","description":"Optionally one of mno, fmc, sip to limit to SIMs of this type"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 11:43:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"176"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"e9f42dc6d5a432f50d2efb6c7340ac17c2286e1a"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"msisdn\": \"447700900123\",\n \"type\": \"sip\",\n \"enterprise\": \"AcmeWidgets\",\n \"label\": \"AcmeOnCallSIM\",\n \"status\": \"active\"\n }\n ],\n \"count\": 1\n}"}],"_postman_id":"1b2122f3-9e8f-43ed-932d-856c3e0498b9"},{"name":"Available SIMs ","id":"974181ee-e31b-4518-97a5-f3c89448897d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/sims/available?type","description":"

Returns a list of SIMs that have been allocated to your Service Provider account and have not yet been activated.

This will typically represent stock of SIMs you have received but not yet allocated to your customer.

SIMs must be activated before use.

Prior to activation SIMs will indicate an available_type indicating which services they may be used for. Notably SIMs ordered for use with the ApaloSIM SIP Service (type sip) cannot be provisioned as mno, data or fmc and vice-versa

When a SIM is activated its type becomes fixed, you cannot change a SIM from fmc to mno service, for example.

Optionally limit to SIMs available for use as sip, fmc, data, or mno

\n","type":"text/plain"},"key":"type","value":null}],"variable":[]}},"response":[{"id":"23103444-e302-41c3-b5b8-d9856dfec933","name":"Available SIMs ","originalRequest":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/sims/available"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 11:46:56 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"609"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"1d7cb595456a94f5c826cd523995434929a5d96e"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944122609999999902\",\n \"msisdn\": \"447700900661\",\n \"available_type\": [ \"sip\" ]\n },\n {\n \"iccid\": \"8944122609999999903\",\n \"msisdn\": \"447700900662\"\n \"available_type\": [ \"mno\", \"fmc\", \"data\" ]\n }\n ],\n \"count\": 2\n}"}],"_postman_id":"974181ee-e31b-4518-97a5-f3c89448897d"},{"name":"Activate New SIM","id":"2b833f4b-08c7-4c48-8fc5-553cc690aebb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"fmc\",\n \"enterprise\": \"AcmeWidgets\",\n \"data_bundle\": 1,\n \"label\": \"AcmeWidgetsMobile\"\n}"},"url":"https://api.apalo.io/v1/sims/available/:iccid/activate","description":"

Activate a new available SIM.

Activation will start billing this SIM, billing will continue until the SIM is terminated. It is not possible to activate SIMs solely for testing the API, so please be sure you want to activate the SIM before calling this endpoint

The type must be one of the following and must be one of the available_type associated with this SIM (See the Available SIMs List);

mno Mobile Network Only - This is a simple mobile service with no special functionality, the SIM will work like any other SIM and all calls will be routed directly by the MNO. You will receive CDRs for calls made.
data Mobile Data Only - This is a data only SIM, it cannot make outbound calls, or send or receive SMS. It must have an active data service at all times.
fmc Fixed Mobile Convergence - This is for use with the FMC functionality of the Apalo UC Platform only. The SIM must be associated with an enterprise before it can be used. Calls will be routed via the Apalo UC Platform.
sip SIP Registation - This is for use with the ApaloSIM product, MO and MT calls will be routed to your own SIP Platform(s)

The data_bundle must be one of the following (in each case the 'gb' suffix is optional, the integer value can be used instead); 1gb, 3gb, 10gb, 30gb, or 100gb. If no bundle is specified, the SIM will not be able to use mobile data services.

The label is a free string for your own reference, it will be displayed in the Apalo portal(s)

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"8944120006612345678","key":"iccid"}]}},"response":[{"id":"728757c2-3b38-4f83-91f2-e9943a54e71a","name":"Activate New SIM","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"fmc\",\n \"enterprise\": \"AcmeWidgets\",\n \"data_bundle\": 1,\n \"label\": \"AcmeWidgetsMobile\"\n}"},"url":{"raw":"https://api.apalo.io/v1/sims/available/:iccid/activate","host":["https://api.apalo.io/v1"],"path":["sims","available",":iccid","activate"],"variable":[{"key":"iccid","value":"","description":"ICCID (Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"changes_pending\": true,\n \"txn\": \"16227215053815\"\n }\n ]\n}"}],"_postman_id":"2b833f4b-08c7-4c48-8fc5-553cc690aebb"},{"name":"Get SIM Detail","id":"435d5e6f-7de7-4371-b7c8-fa68ced544a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/sims/allocated/:iccid","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}},"urlObject":{"path":["sims","allocated",":iccid"],"host":["https://api.apalo.io/v1"],"query":[],"variable":[{"description":{"content":"

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"8944120006612345678","key":"iccid"}]}},"response":[{"id":"2432c832-0e07-4558-9d14-9a7764cd49db","name":"Get SIM Detail","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid"],"variable":[{"key":"iccid","value":"","description":"ICCID (Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"msisdn\": \"447700900123\",\n \"type\": \"mno\",\n \"label\": \"AcmeMobile\",\n \"status\": \"active\",\n \"changes_pending\": false,\n \"enterprise\": null,\n \"date_allocated\": \"2020-09-01 00:00:00\",\n \"date_activated\": \"2020-09-20 16:23:22\",\n \"date_terminated\": null,\n \"pin1\": \"1111\",\n \"pin2\": \"1111\",\n \"puk1\": \"93820383\",\n \"puk2\": \"64990121\"\n }\n ]\n}"}],"_postman_id":"435d5e6f-7de7-4371-b7c8-fa68ced544a5"},{"name":"Suspend SIM","id":"fa5d418e-93fa-4ba8-bf87-c52c6ae26bbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.apalo.io/v1/sims/allocated/:iccid/suspend","description":"

Suspend the specified SIM.

A suspended SIM will be unable to make or receive calls, SMS, and will not be able to use any mobile data service.

Monthly billing continues for suspended SIMs.

NB This is an Asynchronous Command as detailed in the documentation at the beginning of this section

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"8944120006612345678","key":"iccid"}]}},"response":[{"id":"8f927a03-05b6-4e95-886a-0ab8725d51d6","name":"Suspend SIM","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\"{}\""},"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/suspend","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","suspend"],"variable":[{"key":"iccid","value":"","description":"ICCID (Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"changes_pending\": true,\n \"txn\": \"16227215053815\"\n }\n ]\n}"}],"_postman_id":"fa5d418e-93fa-4ba8-bf87-c52c6ae26bbe"},{"name":"Set SIM Details","id":"d6a830b0-c259-4cc3-b834-8d65ecabd3aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"label\": \"Your Label\"\n}"},"url":"https://api.apalo.io/v1/sims/allocated/:iccid","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}},"urlObject":{"path":["sims","allocated",":iccid"],"host":["https://api.apalo.io/v1"],"query":[],"variable":[{"description":{"content":"

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"8944120006612345678","key":"iccid"}]}},"response":[],"_postman_id":"d6a830b0-c259-4cc3-b834-8d65ecabd3aa"},{"name":"Unsuspend SIM","id":"b6ef899b-7f2d-4e2d-9491-6238035bc71d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"\"{}\""},"url":"https://api.apalo.io/v1/sims/allocated/:iccid/unsuspend","description":"

Unsuspend the specified SIM.

Reverses the suspend operation.

NB This is an Asynchronous Command as detailed in the documentation at the beginning of this section

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"8944120006612345678","key":"iccid"}]}},"response":[{"id":"03c5dec5-ce4d-42c9-8af3-fb1e2a34650d","name":"Unsuspend SIM","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\"{}\""},"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/unsuspend","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","unsuspend"],"variable":[{"key":"iccid","value":"","description":"ICCID (Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"changes_pending\": true,\n \"txn\": \"16227215053815\"\n }\n ]\n}"}],"_postman_id":"b6ef899b-7f2d-4e2d-9491-6238035bc71d"},{"name":"Terminate SIM","id":"532dfb40-cd3c-4c8f-bc12-7a35d63b5192","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"\"{}\""},"url":"https://api.apalo.io/v1/sims/allocated/:iccid/terminate","description":"

Irreversibly Terminate service on the specified SIM.

This operation is irreversible and renders the SIM card useless. This should only be used to permanently deactivate a SIM in the event of the customer cancelling service.

Monthly billing ceases for terminated SIMs.

NB This is an Asynchronous Command as detailed in the documentation at the beginning of this section

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"8944120006612345678","key":"iccid"}]}},"response":[{"id":"3db5f506-41d9-40d7-9f47-01e16f629228","name":"Terminate SIM","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"\"{}\""},"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/terminate","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","terminate"],"variable":[{"key":"iccid","value":"8944120006612345678","description":"ICCID (Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"changes_pending\": true,\n \"txn\": \"16227215054930\"\n }\n ]\n}"}],"_postman_id":"532dfb40-cd3c-4c8f-bc12-7a35d63b5192"},{"name":"Pending Operations","id":"9b6fe8c3-7488-41ac-b5b5-2557069436a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.apalo.io/v1/sims/pending","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}},"urlObject":{"path":["sims","pending"],"host":["https://api.apalo.io/v1"],"query":[],"variable":[]}},"response":[{"id":"2f6442dc-e28a-4e69-a923-7e7942687a3a","name":"Pending Operations","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.apalo.io/v1/sims/pending"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 11:12:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"e499f95ee3f430489e463b1635d2649a113292b2"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n [\n {\n \"txn\": \"16227215053815\",\n \"iccid\": \"8944120006612345678\",\n \"msisdn\": \"447700900123\",\n \"ds_requested\": \"2021-06-03 11:58:25\",\n \"action\": \"suspend\"\n }\n ]\n ]\n}"}],"_postman_id":"9b6fe8c3-7488-41ac-b5b5-2557069436a6"}],"id":"e5827682-2a3e-4eac-8ef0-fcd24afd2a6d","description":"

These functions manage the provisioning of the SIM on the Mobile Network such as activating and suspending SIM cards.

Asynchronous Network Operations

A number of these functions require communication with the HLR or other elements of the MNO.

These functions are asynchronous in nature, and will typically complete within a couple of minutes but at times may take longer.

98% of all requests will complete in under 15 minutes, but we will not consider a request has failed until three hours from the request has elapsed.

Where a call is made to a function that operates asynchronously the response will include a txn parameter. The {Pending Operations} endpoint can be used to check the status of any pending operation.

\n","_postman_id":"e5827682-2a3e-4eac-8ef0-fcd24afd2a6d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}},{"name":"Mobile Data and Calls","item":[{"name":"Get Data Usage","id":"2438b278-4acf-4bdb-bb24-3908d84e7395","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"https://api.apalo.io/v1/sims/allocated/:iccid?year=Y&month=M","urlObject":{"path":["sims","allocated",":iccid"],"host":["https://api.apalo.io/v1"],"query":[{"description":{"content":"

Full Year i.e. 2025

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

Month Number i.e. 04 for April

\n","type":"text/plain"},"key":"month","value":"M"},{"disabled":true,"description":{"content":"","type":"text/plain"},"key":null,"value":null}],"variable":[{"description":{"content":"

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"8944120006612345678","key":"iccid"}]}},"response":[],"_postman_id":"2438b278-4acf-4bdb-bb24-3908d84e7395"}],"id":"6e180ca9-e1ad-4646-bf22-e767472d1170","description":"

API for accessing current and historic data usage and call information

\n","_postman_id":"6e180ca9-e1ad-4646-bf22-e767472d1170","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}},{"name":"Mobile Services Configuration","item":[{"name":"Get SIM Services Config","id":"679e0441-be2c-4cf8-a8ce-422e1f483cd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/sims/allocated/:iccid/config","description":"

Get the current mobile network configuration for this SIM.

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"","key":"iccid"}]}},"response":[{"id":"8b6acf01-f49b-4346-976e-98efc3cde7b7","name":"Get SIM Services Config","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/config","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","config"],"variable":[{"key":"iccid","value":"8944120006612345678","description":"ICCID (Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"msisdn\": \"447700900123\",\n \"type\": \"mno\",\n \"changes_pending\": false,\n \"enable_data\": true,\n \"data_bundle\": \"1gb\",\n \"roaming\": \"eu\",\n \"roaming_daily_pack\": false,\n \"enable_prs\": false,\n \"enable_adult\": false\n }\n ]\n}"}],"_postman_id":"679e0441-be2c-4cf8-a8ce-422e1f483cd9"},{"name":"Change SIM Services Config","id":"f1a5168f-13cd-4e13-ab48-64bfe7d001e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"enable_prs\": false,\n \"enable_adult\": false\n}"},"url":"https://api.apalo.io/v1/sims/allocated/:iccid/config","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}},"urlObject":{"path":["sims","allocated",":iccid","config"],"host":["https://api.apalo.io/v1"],"query":[],"variable":[{"description":{"content":"

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"","key":"iccid"}]}},"response":[{"id":"97dc59f4-ec13-48e6-a82a-32b3b8bdacfd","name":"Change SIM Services Config","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enable_prs\": false,\n \"enable_adult\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/config","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","config"],"variable":[{"key":"iccid","value":"8944120006612345678","description":"ICCID (Required)"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"changes_pending\": true,\n \"txn\": \"1622721506323\"\n }\n ]\n}"}],"_postman_id":"f1a5168f-13cd-4e13-ab48-64bfe7d001e2"}],"id":"360c4ca1-311b-4dc7-972c-4cf9cba37eff","description":"

These functions manage service on the Mobile Network. Much like SIM Provisioning, these are Asynchronous in nature.

Mobile Services

The following service parameters can be configured on a per-SIM basis;

data_bundle - The SIM data bundle, one of 1gb, 3gb, 10gb, 30gb, or 100gb.
roaming - International Roaming, one of eu, global, or none
roaming_daily_pack - Enable the daily data roaming pack (subject to availability, please see your service agreement for details)
enable_prs - Enable access to Premium Rate Services (including PRS numbers and Premium SMS services) - where the SIM type is fmc or sip this does not affect access to PRS numbers.
enable_adult - Enable access to material, numbers, or services that would be blocked by Adult Content Barring.

\n","_postman_id":"360c4ca1-311b-4dc7-972c-4cf9cba37eff","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}},{"name":"Mobile Spend Limits","item":[{"name":"Get SIM Spend Limits","id":"0cd46d97-9eed-41cc-ae8f-0417cad4ef2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/sims/allocated/:iccid/limits","description":"

Get the current spend limits for this SIM.

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"","key":"iccid"}]}},"response":[{"id":"514215d4-590d-4666-a801-c817a4e97cef","name":"Get SIM Spend Limits","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/limits","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","limits"],"variable":[{"key":"iccid","value":"8944120006612345678","description":"ICCID (Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"msisdn\": \"447700900123\",\n \"cost_limit\": 70,\n \"cost_warn\": 30,\n \"send_sms_warn\": false\n }\n ]\n}"}],"_postman_id":"0cd46d97-9eed-41cc-ae8f-0417cad4ef2f"},{"name":"Change SIM Spend Limits","id":"5399472c-c42d-4d34-91ca-2f64549de64f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cost_limit\": 70,\n \"cost_warn\": 30,\n \"send_sms_warn\": false\n}"},"url":"https://api.apalo.io/v1/sims/allocated/:iccid/limits","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}},"urlObject":{"path":["sims","allocated",":iccid","limits"],"host":["https://api.apalo.io/v1"],"query":[],"variable":[{"description":{"content":"

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"","key":"iccid"}]}},"response":[{"id":"3aa30686-4f16-4220-bebe-8328b7473440","name":"Change SIM Spend Limits","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cost_limit\": 70,\n \"cost_warn\": 30,\n \"send_sms_warn\": false\n}"},"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/limits","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","limits"],"variable":[{"key":"iccid","value":"8944120006612345678","description":"ICCID (Required)"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"msisdn\": \"447700900123\",\n \"cost_limit\": 70,\n \"cost_warn\": 30,\n \"send_sms_warn\": false\n }\n ]\n}"}],"_postman_id":"5399472c-c42d-4d34-91ca-2f64549de64f"}],"id":"9f538491-40db-4305-b17a-07240a3873f5","description":"

It is possible to set spend limits on a per-SIM basis. These are based on the cost price to you, the Apalo Customer, therefore cannot be used to limit your customers' bills unless you are operating a percentage markup (in which case you should set the limits to the cost price), and are enforced on a reasonable efforts basis.

You remain responsible for all chargeable events on all SIMs on your account. The failure of a limit to function correctly, or delayed billing events, does not create a liability for Apalo

Mobile Spend Limits

The following parameters can be configured on a per-SIM basis;

cost_limit - The amount (in GBP) at which service will be restricted
cost_warn - The amount (in GBP) at which a warning will be generated. This will be eMailed to the address(es) we have on file. Please raise a ticket to confirm what address(es) you would like to receive this warning.
send_sms_warn - A boolean value. If true will cause an SMS to be sent to the handset when cost_warn is reached.

SMS Warning

The SMS message will be sent to the SIM directly and will be as follows;

\n
Your mobile spend is approaching your pre-defined limit. Your service may be limited. If you did not expect this message, please contact your service provider.
\n

This is designed to be generic in nature. You may wish, instead, to send the customer a message directly using the SMS API.

\n","_postman_id":"9f538491-40db-4305-b17a-07240a3873f5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}},{"name":"ApaloSIM SIP","item":[{"name":"Get SIP Config","id":"8f182b1b-06fc-450d-8766-40bac330cfb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/sims/allocated/:iccid/sip/config","description":"

Get the current configuration of a SIP Registration SIM.

NB The sip_password parameter will always be true as for security reasons the password can only be set, not retrieved, via the API

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"","key":"iccid"}]}},"response":[{"id":"fcc34f86-9fd9-4280-9960-ba84248d5429","name":"Get SIP Registration Config","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/sip/config","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","sip","config"],"variable":[{"key":"iccid","value":"8944120006612345678","description":"ICCID (Required)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 10:55:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"367"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"95b356b117f66cec7bce050d30ec010d1a2e1d23"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"msisdn\": \"447700900123\",\n \"type\": \"sip\",\n \"enable_registration\": true,\n \"sip_type\": \"registration\",\n \"sip_host\": \"sip.example.com\",\n \"sip_user\": \"1001\",\n \"sip_auth_user\": \"1001\",\n \"sip_password\": true,\n \"sip_expires\": 60,\n \"sip_tls\": \"disabled\",\n \"sip_srtp\": \"disabled\"\n }\n ]\n}"}],"_postman_id":"8f182b1b-06fc-450d-8766-40bac330cfb7"},{"name":"Get SIP Registration Status","id":"5a3f70ca-5fad-4b7b-b711-bda93e221e3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/sims/allocated/:iccid/sip/status","description":"

Get the current status of a SIP Registration SIM.

The current registration details will be shown including the SIP Expiry

The last_call object will contain information on the last call made to (MT) and from (MO) the SIM.

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"","key":"iccid"}]}},"response":[{"id":"a6d0c334-14dc-4c60-84b2-daaecdc2cbed","name":"Get SIP Registration Status","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/sip/status","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","sip","status"],"variable":[{"key":"iccid","value":"8944120006612345678","description":"ICCID (Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 11:04:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"334"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"b029dd01c51c4a4077fedff0577636286b77c29a"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"msisdn\": \"447700900123\",\n \"type\": \"sip\",\n \"status\": \"registered\",\n \"registration\": {\n \"sip_host\": \"sip:sip.example.com:5060\",\n \"sip_user\": \"1001\",\n \"sip_auth_user\": \"1001\",\n \"realm\": null,\n \"expires\": 20,\n \"reg_since\": \"2021-05-26 14:04:36\",\n \"reg_expires\": \"2021-06-03 11:04:38\"\n },\n \"last_call\": []\n }\n ]\n}"}],"_postman_id":"5a3f70ca-5fad-4b7b-b711-bda93e221e3c"},{"name":"Set SIP Config","id":"3db008d8-dc32-4617-a293-147a7fdb4d20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sip_type\": \"registration\",\n \"enable_registration\": true,\n \"sip_host\": \"sip.example.com\",\n \"sip_user\": \"1001\",\n \"sip_auth_user\": \"1001\",\n \"sip_password\": \"CorrectHorseBatteryStaple306\",\n \"sip_expires\": 60,\n \"sip_tls\": \"disabled\",\n \"sip_srtp\": \"disabled\",\n}"},"url":"https://api.apalo.io/v1/sims/allocated/:iccid/sip/config","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}},"urlObject":{"path":["sims","allocated",":iccid","sip","config"],"host":["https://api.apalo.io/v1"],"query":[],"variable":[{"description":{"content":"

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"","key":"iccid"}]}},"response":[{"id":"fd681b0a-08da-4468-b952-eed68f3a16f3","name":"Set SIP Config (Registration)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sip_type\": \"registration\",\n \"enable_registration\": true,\n \"sip_host\": \"sip.example.com\",\n \"sip_user\": \"1001\",\n \"sip_auth_user\": \"1001\",\n \"sip_password\": \"CorrectHorseBatteryStaple306\",\n \"sip_expires\": 60,\n \"sip_tls\": \"disabled\",\n \"sip_srtp\": \"disabled\",\n}"},"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/sip/config","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","sip","config"],"variable":[{"key":"iccid","value":"8944120006612345678","description":"ICCID (Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"msisdn\": \"447700900123\",\n \"type\": \"sip\",\n \"enable_registration\": true,\n \"sip_type\": \"registration\",\n \"sip_host\": \"sip.example.com\",\n \"sip_user\": \"1001\",\n \"sip_auth_user\": \"1001\",\n \"sip_password\": true,\n \"sip_expires\": 60,\n \"sip_tls\": \"disabled\",\n \"sip_srtp\": \"disabled\",\n }\n ]\n}"},{"id":"3a4b7106-e4f5-4352-83a5-784b0549c5fd","name":"Set SIP Config (Endpoint)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"enable_registration\": false,\n \"sip_type\": \"endpoint\",\n \"sip_mo_endpoint\": \"sip:sip.example.com;transport=udp\"\n}\n"},"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/sip/config","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","sip","config"],"variable":[{"key":"iccid","value":"8944120006612345678","description":"ICCID (Required) "}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"msisdn\": \"447700900123\",\n \"type\": \"sip\",\n \"enable_registration\": false,\n \"sip_type\": \"endpoint\",\n \"sip_mo_endpoint\": \"sip:sip.example.com;transport=udp\",\n }\n ]\n}"}],"_postman_id":"3db008d8-dc32-4617-a293-147a7fdb4d20"},{"name":"Remove SIP Config","id":"09bd3d08-ca7f-4ee9-941b-a38a52aa1401","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.apalo.io/v1/sims/allocated/:iccid/sip/config","description":"

Disable SIP Registration for this SIM.

The SIM will remain in service and will continue to be able to use Data and SMS services if configured to do so.

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"iccid"}]}},"response":[],"_postman_id":"09bd3d08-ca7f-4ee9-941b-a38a52aa1401"}],"id":"2954ccc4-fd26-4c71-840f-d85d552a4a5e","description":"

These endpoints are for the ApaloSIM service.

These do not apply to SIMs used for Mobile Only or FMC Services on the Apalo UC Platform.

SIP Registration

Where SIP registration is enabled, the following parameters can be provided;

sip_type this should be set to registration for all registrations
enable_registration a simple boolean to control whether or not this registration is active (default: true)
sip_host the FQDN hostname or IP address of the SIP server to register to. This can optionally include a port and transport (e.g. sip.example.com:5060;transport=tcp) where not provided, port 5060 is assumed. Where the hostname provided has SRV records these will be respected.
sip_user the SIP username for registration, will also be present in the SIP From header for calls made from this SIM.
sip_auth_user the SIP authentication username (if different)
sip_password the password for the SIP account for registration and authenticating MO calls. This is never returned in any future API call so may be sent as the boolean true to retain the current password.
realm this is currently ignored and should not be provided
expires (seconds) the expiry time for the SIP registration, defaults to 60s. Please note that setting this too high can cause registrations to time out on some platforms. Also, if you disable and re-enable this registration then the registration may not be re-attempted until expires seconds have passed.

MO Calls to SIP Endpoint

Customers using their own SBC with ApaloSIM may prefer to route all MO traffic via an IP-authenticated trunk directly to their SBC. This can be achieved via the API as follows.

NB All calls are delivered with the RURI / To user as the number dialled on the SIM and the PAI will contain the SIM MSISDN to enable you to identify the originator of the call. No authentication is supported.

sip_type this should be set to endpoint for SIMs configured in this way.
enable_registration should be set to false for SIMs configured in this way.
sip_mo_endpoint the FQDN hostname or IP address of the SIP server to send MO calls to. This can optionally include a port and transport (e.g. sip.example.com:5060;transport=tcp) where not provided, port 5060 is assumed. Where the hostname provided has SRV records these will be respected.

All MO calls will be routed as dialled to the provided endpoint, e.g. a call to 1004 will appear to sip:1004@sip.example.com:5060;transport=tcp

Some numbers (e.g. 11x, 999 etc) are not routed to your platform.

\n","_postman_id":"2954ccc4-fd26-4c71-840f-d85d552a4a5e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}},{"name":"ApaloSIM Inbound MSISDNs","item":[{"name":"Get Inbound Routing Config","id":"1874e4dc-36fd-4af3-9814-e9afc7a3ddb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/sims/allocated/:iccid/inbound/config","description":"

Get the current inbound routing configuration for calls to the MSISDN associated with this SIM.

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"8944120006612345678","key":"iccid"}]}},"response":[{"id":"988c087d-8f0b-42a6-a8e8-745b334d413a","name":"Get Inbound Routing Config","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/inbound/config","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","inbound","config"],"variable":[{"key":"iccid","value":"8944120006612345678","description":"ICCID (Required)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 10:55:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"367"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"95b356b117f66cec7bce050d30ec010d1a2e1d23"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"msisdn\": \"447700900123\",\n \"type\": \"sip\",\n \"inbound_method\": \"endpoint\",\n \"inbound_endpoint\": \"sip.example.com;transport=tcp\",\n \"inbound_distinct_origin\": true\n }\n ]\n}"}],"_postman_id":"1874e4dc-36fd-4af3-9814-e9afc7a3ddb8"},{"name":"Set Inbound Routing Config","id":"18eb4f08-53f3-48af-9232-160cdee06882","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.apalo.io/v1/sims/allocated/:iccid/inbound/config","description":"

Inbound calls to the MSISDN associated with the SIM can either be routed directly to the SIM or to a SIP endpoint of your choice such as your SBC or IP PBX for full control of the inbound call flow.

NB These should be treated the same as inbound calls from Apalo Numbering. It is not possible at this time to register TO the ApaloSIM platform to receive calls to the MSISDN by registration, nor will the inbound calls reply to a 401 Authentication challenge. You should authenticate the inbound calls to the MSISDN by IP.

There are two main parameters;

inbound_method may be one of endpoint, or direct (Direct to SIM)
inbound_endpoint is only valid (and mandatory) where the endpoint method is selected, and should be a SIP FQDN or IP e.g. sip.example.com:5060;transport=tcp - the username part of the URI is omitted as this will always be the MSISDN.

Additionally, there are some further parameters that control how the call is routed to your platform;

inbound_distinct_origin if set true will cause inbound calls to originate from a different IP / Host than your SIP registrations

inbound_distinct_origin

This parameter was introduced for improved compatibility and simplifying configuration for SIP platforms that expect your inbound 'carrier' trunks to have their own IPs (i.e. they cannot share the IP with a registered device).

Please contact your account manager before enabling this option, and ensure that the appropriate IP addresses are permitted by any ACLs.

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"8944120006612345678","key":"iccid"}]}},"response":[{"id":"658e896b-1234-426e-a4f9-bd9bfaba2525","name":"Set Inbound Routing (SIP Endpoint)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"inbound_method\": \"endpoint\",\n \"inbound_endpoint\": \"sip.example.com;transport=tcp\",\n \"inbound_distinct_origin\": true\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/inbound/config","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","inbound","config"],"variable":[{"key":"iccid","value":"8944120006612345678","description":"ICCID (Required)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 10:55:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"367"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"95b356b117f66cec7bce050d30ec010d1a2e1d23"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"msisdn\": \"447700900123\",\n \"type\": \"sip\",\n \"inbound_method\": \"endpoint\",\n \"inbound_endpoint\": \"sip.example.com;transport=tcp\",\n \"inbound_distinct_origin\": true\n }\n ]\n}"},{"id":"b9fc0b7b-893a-4a83-af33-f12ed64522ce","name":"Set Inbound Routing (Direct to SIM)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"inbound_method\": \"direct\",\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.apalo.io/v1/sims/allocated/:iccid/inbound/config","host":["https://api.apalo.io/v1"],"path":["sims","allocated",":iccid","inbound","config"],"variable":[{"key":"iccid","value":"8944120006612345678","description":"ICCID (Required)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 10:55:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"367"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"95b356b117f66cec7bce050d30ec010d1a2e1d23"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"iccid\": \"8944120006612345678\",\n \"msisdn\": \"447700900123\",\n \"type\": \"sip\",\n \"inbound_method\": \"direct\"\n }\n ]\n}"}],"_postman_id":"18eb4f08-53f3-48af-9232-160cdee06882"},{"name":"Remove Inbound Routing Config","id":"6415f8cb-a5f7-4e65-9431-05f12802607b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.apalo.io/v1/sims/allocated/:iccid/inbound/config","description":"

Immediately removes the inbound routing configuration for calls to this MSISDN.

Calls to the MSISDN associated with the SIM will fail.

ICCID (Required)

\n","type":"text/plain"},"type":"any","value":"8944120006612345678","key":"iccid"}]}},"response":[],"_postman_id":"6415f8cb-a5f7-4e65-9431-05f12802607b"}],"id":"b93fe609-5b9d-42c6-9a1d-ef72581c1982","_postman_id":"b93fe609-5b9d-42c6-9a1d-ef72581c1982","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}},{"name":"ApaloSIM SIP ACLs","item":[{"name":"List IPs","id":"618b8cef-62f7-4d84-9dab-2d5eede248ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/acls/mt","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}},"urlObject":{"path":["acls","mt"],"host":["https://api.apalo.io/v1"],"query":[],"variable":[]}},"response":[{"id":"2210615f-7a6b-4ab3-80e1-5704e33d5d42","name":"List IPs","originalRequest":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/acls/mt"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Jul 2021 14:50:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"66"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"4e95e020cf66a37014089c55214d2599a35ae3df"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"success\":true,\"data\":[{\"ip4\":\"10.0.0.4\",\"date\":\"2021-07-26 14:23:18\"}],\"count\":1}"}],"_postman_id":"618b8cef-62f7-4d84-9dab-2d5eede248ab"},{"name":"Add IP Address","id":"406820d6-2400-49ff-8e8b-1ae6142e873f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.apalo.io/v1/acls/mt/:ip","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}},"urlObject":{"path":["acls","mt",":ip"],"host":["https://api.apalo.io/v1"],"query":[],"variable":[{"description":{"content":"

IP Address

\n","type":"text/plain"},"type":"any","value":"","key":"ip"}]}},"response":[{"id":"ce7c3763-589b-4e7d-b20f-e36aecbaf326","name":"Add IP Address","originalRequest":{"method":"PUT","header":[],"url":{"raw":"https://api.apalo.io/v1/acls/mt/:ip","host":["https://api.apalo.io/v1"],"path":["acls","mt",":ip"],"variable":[{"key":"ip","value":"10.0.0.4","description":"IP Address"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Jul 2021 14:50:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"66"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"4e95e020cf66a37014089c55214d2599a35ae3df"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"ip4\": \"10.0.0.4\",\n \"date\": \"2021-07-26 14:29:18\"\n }\n ]\n}"}],"_postman_id":"406820d6-2400-49ff-8e8b-1ae6142e873f"},{"name":"Remove IP Address","id":"458de1a9-c0bd-4ac7-86ab-cecd452cfdd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.apalo.io/v1/acls/mt/:ip","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}},"urlObject":{"path":["acls","mt",":ip"],"host":["https://api.apalo.io/v1"],"query":[],"variable":[{"description":{"content":"

IP Address

\n","type":"text/plain"},"type":"any","value":"","key":"ip"}]}},"response":[{"id":"1e09e81a-6a72-462b-8513-3f7991478c75","name":"List ACLs","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.apalo.io/v1/acls/mt/:ip","host":["https://api.apalo.io/v1"],"path":["acls","mt",":ip"],"variable":[{"key":"ip","value":"10.0.0.4","description":"IP Address"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 26 Jul 2021 14:50:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"66"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"4e95e020cf66a37014089c55214d2599a35ae3df"},{"key":"Access-Control-Allow-Origin","value":""},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\"status\":200,\"success\":true}"}],"_postman_id":"458de1a9-c0bd-4ac7-86ab-cecd452cfdd7"}],"id":"dc8e9f1b-130b-4db9-b3f6-83b3e38f9441","description":"

These functions are only to be used by customers using the SIP Endpoint integration with ApaloSIM.

They are not required if you're using SIP Registrations, and you should not add the IP addresses of any IP PBX or platform that is using the SIP Registration service.

Please note that all IP addresses added to the MT ACL will be able to call your SIMs without restriction. It is your responsibility to ensure these systems are appropriately secured. By submitting an IP address via this API you warrant that you are responsible for all traffic originating from the IP address.

\n","_postman_id":"dc8e9f1b-130b-4db9-b3f6-83b3e38f9441","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}}],"id":"bbd94dcd-c58f-43ea-b2a4-020b7c69ca76","_postman_id":"bbd94dcd-c58f-43ea-b2a4-020b7c69ca76","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}},{"name":"Hosted UC","item":[{"name":"Enterprises","item":[{"name":"Get Enterprise List","id":"223e211b-7e9b-4b36-977a-518a666d43f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/enterprises?search=&limit=&start=","description":"

Get a list of Enterprises on the Apalo Hosted UC Platform.

(Required) Search for enteprises containing specific digits, * is wildcard

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

(Required) Limit number of results (use with Start to enable pagination)

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

(Required) If using pagination, the sequence number to start from

\n","type":"text/plain"},"key":"start","value":""}],"variable":[]}},"response":[{"id":"5dfdfae1-963a-4de7-9498-3f9961761fa0","name":"Get Enterprise List","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.apalo.io/v1/enterprises?search=&limit=&start=","host":["https://api.apalo.io/v1"],"path":["enterprises"],"query":[{"key":"search","value":"","description":"(Required) Search for enteprises containing specific digits, * is wildcard"},{"key":"limit","value":"","description":"(Required) Limit number of results (use with Start to enable pagination)"},{"key":"start","value":"","description":"(Required) If using pagination, the sequence number to start from"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 13:25:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"491"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"c564740be7421aa9ebd0ec2b37f1715f184c142e"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"enterprise\": \"ENT300200110\",\n \"name\": \"ACME WIDGETS\",\n \"billing_account\": \"300200110\",\n \"default_number\": \"441632900123\"\n },\n {\n \"enterprise\": \"ENT300200148\",\n \"name\": \"ACME SERVICES\",\n \"billing_account\": \"300200148\",\n \"default_number\": \"441632900500\"\n }\n ]\n}"}],"_postman_id":"223e211b-7e9b-4b36-977a-518a666d43f4"},{"name":"Create New Enterprise","id":"d50ee026-fe96-4e25-866f-cb278aa38212","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Global Enterprises\",\n \"id\": \"GLOBALENT1\",\n \"email\": \"admin@global.example.com\",\n \"postcode\": \"AA1 2BC\"\n}"},"url":"https://api.apalo.io/v1/enterprises/create","description":"

Create a new Enterprise on the Apalo Hosted UC Platform.

The following parameters are mandatory;

name - The long name of the Enterprise, typically the full company name.
email - The eMail address of the primary user of this enterprise, this will be created as the first admin account for this enterprise.
postcode - The postcode of the Enterprise.

Optionally, you can also specify id which is a unique identifier for this enterprise. If not specified it will be automatically generated.

The id, if specified, is limited to 14 characters with no spaces and only limited punctuation.

Admin Account

When the enterprise is created, an admin account will be created for the email provided.

A password will be automatically generated for this account, which will be provided in response to this API call.

NB The password cannot be retrieved at a later date, and is not automatically sent to the eMail address, we recommend you send a notification to the customer when their account is created successfully to allow them to login and manage their hosted enterprise.

Get details of an individual Enterprise, including the dialplan and numbering associated with the enterprise.

(Required) Enterprise ID / Short Name

\n","type":"text/plain"},"type":"any","value":"","key":"enterprise"}]}},"response":[{"id":"4aced3de-933e-45fc-8225-3009fa3a45b9","name":"Get Enterprise","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.apalo.io/v1/enterprises/:enterprise","host":["https://api.apalo.io/v1"],"path":["enterprises",":enterprise"],"variable":[{"key":"enterprise","value":"","description":"(Required) Enterprise ID / Short Name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"enterprise\": \"GLOBALENT1\",\n \"name\": \"Global Enterprises\",\n \"mbn\": \"441632900123\",\n \"internal_dialplan\": [\n {\n \"length\": 4,\n \"start\": [\n \"2\",\n \"3\"\n ]\n },\n {\n \"length\": 3,\n \"start\": [\n \"5\",\n \"7\"\n ]\n }\n ],\n \"default_number\": \"441632900123\",\n \"numbers\": [\n {\n \"number\": \"441632900123\",\n \"country\": \"44\",\n \"label\": null,\n \"is_default\": true\n },\n {\n \"number\": \"441632900150\",\n \"country\": \"44\",\n \"label\": null,\n \"is_default\": false\n }\n ]\n }\n ]\n}"}],"_postman_id":"8d7c4e35-8b85-4b56-bd25-89208c94e91c"},{"name":"Delete Enterprise","id":"5bbdb40e-0d3b-4047-81d0-d7816f792541","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.apalo.io/v1/enterprises/:enterprise","description":"

Delete an Enterprise

(Required) Enterprise ID / Short Name

\n","type":"text/plain"},"type":"any","value":"","key":"enterprise"}]}},"response":[{"id":"9678ac2b-ec7e-4784-89a5-469ee12bb61c","name":"Delete Enterprise","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.apalo.io/v1/enterprises/:enterprise","host":["https://api.apalo.io/v1"],"path":["enterprises",":enterprise"],"variable":[{"key":"enterprise","value":"","description":"(Required) Enterprise ID / Short Name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 13:53:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"29"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"f38d912710491142e5d50da2762d729d388df2a6"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true\n}"}],"_postman_id":"5bbdb40e-0d3b-4047-81d0-d7816f792541"}],"id":"272f8761-eeb4-4b29-a37f-e1761c4941f4","_postman_id":"272f8761-eeb4-4b29-a37f-e1761c4941f4","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}},{"name":"Extensions","item":[{"name":"Get Extensions","id":"98592aa8-31f8-467f-9e8c-6e19d7b5464c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/enterprises/:enterprise/extensions","description":"

Get extensions associated with an enterprise

Create a new extension on an enterprise.

An eight digit numeric password is automatically generated when the extension is created, this is used to log in to the desktop application.

(Required) Enterprise ID / Short Name

\n","type":"text/plain"},"type":"any","value":"","key":"enterprise"}]}},"response":[{"id":"81bb2f9e-e4c2-491f-a36f-07b5c04afa49","name":"Create Extension","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"\"{\\\"extension\\\":\\\"562\\\",\\\"firstname\\\":\\\"Test\\\",\\\"lastname\\\":\\\"User 562\\\",\\\"email\\\":\\\"test1622709498@example.com\\\",\\\"login\\\":\\\"test1622709498@example.com\\\"}\""},"url":{"raw":"https://api.apalo.io/v1/enterprises/:enterprise/extensions/create","host":["https://api.apalo.io/v1"],"path":["enterprises",":enterprise","extensions","create"],"variable":[{"key":"enterprise","value":"","description":"(Required) Enterprise ID / Short Name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"extension\": \"2301\",\n \"email\": \"new.user@example.com\",\n \"login\": \"new.user@example.com\",\n \"firstname\": \"New\",\n \"lastname\": \"User\",\n \"password\": \"95116383\",\n \"location\": null,\n \"department\": null,\n \"mobile_number\": null,\n \"custom_cli\": \"441632900234\"\n }\n ]\n}"}],"_postman_id":"aed00703-87c6-4f56-bfae-b074ce08e103"},{"name":"Get Extension Detail","id":"e4e5e404-b003-4348-835f-2fd162270c51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/enterprises/:enterprise/extensions/:extension","description":"

Get detail of an individual extension

(Required) Enterprise ID / Short Name

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

(Required) Extension Number

\n","type":"text/plain"},"type":"any","value":"","key":"extension"}]}},"response":[{"id":"1c406dea-a4eb-4a38-92b7-5f849ac3df16","name":"Get Extension Detail","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.apalo.io/v1/enterprises/:enterprise/extensions/:extension","host":["https://api.apalo.io/v1"],"path":["enterprises",":enterprise","extensions",":extension"],"variable":[{"key":"enterprise","value":"","description":"(Required) Enterprise ID / Short Name"},{"key":"extension","value":"","description":"(Required) Extension Number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"extension\": \"4001\",\n \"firstname\": \"Jane\",\n \"lastname\": \"Doe\",\n \"email\": \"jdoe@example.com\",\n \"login\": \"jdoe@example.com\",\n \"location\": null,\n \"department\": null,\n \"mobile_number\": \"447700900123\",\n \"custom_cli\": null\n }\n ]\n}"}],"_postman_id":"e4e5e404-b003-4348-835f-2fd162270c51"}],"id":"b3751d0e-a4c0-421c-afdc-99a14fc9bbe2","_postman_id":"b3751d0e-a4c0-421c-afdc-99a14fc9bbe2","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}},{"name":"Devices","item":[{"name":"Get Supported Devices","id":"64ec2f14-7914-437e-bb60-0e94b4bf8b11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/enterprises/devices/supported?auto_provision=true","description":"

Get a list of supported devices and the identifiers used when adding them to the platform.

If auto_provision is set to true will return only the devices for which we currently support automatic remote provisioning.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}},"urlObject":{"path":["enterprises","devices","supported"],"host":["https://api.apalo.io/v1"],"query":[{"key":"auto_provision","value":"true"}],"variable":[]}},"response":[{"id":"263af67a-ef02-4f57-bbf4-2098e2c756fe","name":"Get Supported Devices (Auto Provision)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.apalo.io/v1/enterprises/devices/supported?auto_provision=true","host":["https://api.apalo.io/v1"],"path":["enterprises","devices","supported"],"query":[{"key":"auto_provision","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 13:56:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"7292"},{"key":"Connection","value":"keep-alive"},{"key":"Apalo-API-Req","value":"c61be06051c040187ca5b305135d426b16037570"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, X-Requested-With, content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"model\": \"cisco-7902\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco IP phone 7902, sccp protocol\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-7905\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco IP phone 7905, sccp protocol\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-7906\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco IP phone 7906, sccp protocol\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-7910\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco IP phone 7910, sccp protocol\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-7911\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco IP phone 7911, sccp protocol\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-7912\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco IP phone 7912, sccp protocol\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-7920\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco IP phone 7920, sccp protocol\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-7940\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco IP phone 7940, sccp protocol\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-7941\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco IP phone 7941, sccp protocol\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-7961\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco IP phone 7961, sccp protocol\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-7970\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco IP phone 7970, sccp protocol\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-7971\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco IP phone 7971, sccp protocol\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-ata-mgcp\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco ATA\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-ata-spa112\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco SPA 112 ATA\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-ata-spa122\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco SPA 122 ATA\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-cp-6841\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco CP-6841-3PCC\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-cp-6851\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco CP-6851-3PCC\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-cp-7811\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco CP-7811-3PCC\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-cp-7821\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco CP-7821-3PCC\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-cp-7832\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco CP-7832-3PCC\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-cp-7841\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco CP-7841-3PCC\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-cp-7861\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco CP-7861-3PCC\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-cp-8811\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco CP-8811-3PCC\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-cp-8841\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco CP-8841-3PCC\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-cp-8851\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco CP-8851-3PCC\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-cp-8861\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco CP-8861-3PCC\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-spa301\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco SPA 301\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-spa303\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco SPA 303\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-spa501G\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco SPA 501G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-spa502G\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco SPA 502G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-spa504G\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco SPA 504G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-spa508G\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco SPA 508G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-spa509G\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco SPA 509G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-spa512G\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco SPA 512G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-spa514G\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco SPA 514G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-spa525G\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco SPA 525G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"cisco-spa525G2\",\n \"mfr\": \"cisco\",\n \"description\": \"Cisco SPA 525G2\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t53wip\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T53W/T53 / 84.0.30 / v3\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t57wip\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T57W / 84.0.30 / v3\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t54wip\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T54W / 84.0.30 / v3\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-cp860\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink CP860 Conference Phone\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-cp920\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink CP920 Conference Phone\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-cp960\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink CP960 Conference Phone\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t19p\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T19P\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t19pe2\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T19P E2\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t20p\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T20P\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t21p\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T21PE2\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t21p_34\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T21P\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t22p\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T22P\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t23g\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T23G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t23p\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T23P\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t26p\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T26P\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t27g\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T27G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t27p\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T27P\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t28p\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T28P\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t29g\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T29G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t32g\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T32G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t38g\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T38G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t40p\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T40P\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t41p\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T41P\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t41s\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T41S\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t42g\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T42G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t42s\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T42S\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t46g\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T46G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t46s\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T46S\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t48g\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T48G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t48s\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T48S\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t49g\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T49G\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-t58v\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink SIP-T58V\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-vp530\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink VP530\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-w52p\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink W52P\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-w56p\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink W56P\",\n \"auto_provision\": true\n },\n {\n \"model\": \"yealink-w60b\",\n \"mfr\": \"yealink\",\n \"description\": \"Yealink W60B\",\n \"auto_provision\": true\n }\n ]\n}"}],"_postman_id":"64ec2f14-7914-437e-bb60-0e94b4bf8b11"},{"name":"Get Extension Devices","id":"58267fd3-1168-4685-a1a4-973da96c2049","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.apalo.io/v1/enterprises/:enterprise/extensions/:extension/devices","description":"

Get devices associated with an extension

(Required) Enterprise ID / Short Name

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

(Required) Extension Number

\n","type":"text/plain"},"type":"any","value":"","key":"extension"}]}},"response":[{"id":"fd133036-6d1b-4656-b84c-464854226538","name":"Get Extension Devices","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.apalo.io/v1/enterprises/:enterprise/extensions/:extension/devices","host":["https://api.apalo.io/v1"],"path":["enterprises",":enterprise","extensions",":extension","devices"],"variable":[{"key":"enterprise","value":"","description":"(Required) Enterprise ID / Short Name"},{"key":"extension","value":"","description":"(Required) Extension Number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": [\n {\n \"mac\": \"00156582F1AA\",\n \"label\": \"Jo\",\n \"mfr\": \"yealink\",\n \"model\": \"yealink-t46g\",\n \"rps\": true\n }\n ]\n}"}],"_postman_id":"58267fd3-1168-4685-a1a4-973da96c2049"},{"name":"Create Extension Device","id":"1832ffa1-3c97-4e0d-8ec1-4488e4572930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"model\": \"yealink-t46g\",\n \"mac\": \"00156582AABB\"\n}"},"url":"https://api.apalo.io/v1/enterprises/:enterprise/extensions/:extension/devices/add","description":"

Add a new device to an extension.

The extension is specified in the URL itself, and the body of the request should contain the following;

model - the model of the device (as obtained from the Get Supported Devices call above)
mac - the MAC address of the device, this is not case sensitive but will always be returned in lower case

(Required) Enterprise ID / Short Name

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

(Required) Extension Number

\n","type":"text/plain"},"type":"any","value":"","key":"extension"}]}},"response":[{"id":"0f2ecca7-88b1-4ca9-b4a9-843e88339cb5","name":"Create Extension Device","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"model\": \"yealink-t46g\",\n \"mac\": \"00156582AABB\"\n}"},"url":{"raw":"https://api.apalo.io/v1/enterprises/:enterprise/extensions/:extension/devices/add","host":["https://api.apalo.io/v1"],"path":["enterprises",":enterprise","extensions",":extension","devices","add"],"variable":[{"key":"enterprise","value":"","description":"(Required) Enterprise ID / Short Name"},{"key":"extension","value":"","description":"(Required) Extension Number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true,\n \"data\": {\n \"mac\": \"00156582aabb\",\n \"model\": \"yealink-t46g\",\n \"rps\": false\n }\n}"}],"_postman_id":"1832ffa1-3c97-4e0d-8ec1-4488e4572930"},{"name":"Delete Extension Device","id":"9c88c15f-543c-415b-895d-760acb7c7e7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"\"{}\""},"url":"https://api.apalo.io/v1/enterprises/:enterprise/extensions/:extension/devices/:mac","description":"

Remove a device from an extension.

Where the device was provisioned remotely (rps: true) this also removes the provisioning configuration and releases the device from the Apalo platform.

(Required) Enterprise ID / Short Name

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

(Required) Extension Number

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

(Required) Device MAC Address

\n","type":"text/plain"},"type":"any","value":"","key":"mac"}]}},"response":[{"id":"72ffb98a-0e0d-46fc-bebc-9074a961d8ae","name":"Delete Extension Device","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"\"{}\""},"url":{"raw":"https://api.apalo.io/v1/enterprises/:enterprise/extensions/:extension/devices/:mac","host":["https://api.apalo.io/v1"],"path":["enterprises",":enterprise","extensions",":extension","devices",":mac"],"variable":[{"key":"enterprise","value":"","description":"(Required) Enterprise ID / Short Name"},{"key":"extension","value":"","description":"(Required) Extension Number"},{"key":"mac","value":"","description":"(Required) "}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"success\": true\n}"}],"_postman_id":"9c88c15f-543c-415b-895d-760acb7c7e7f"}],"id":"af6c6e83-dfbf-4de6-aca4-a559655b44f0","_postman_id":"af6c6e83-dfbf-4de6-aca4-a559655b44f0","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}}],"id":"9698152e-b259-4f04-b63c-24d088671479","_postman_id":"9698152e-b259-4f04-b63c-24d088671479","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"1a50de91-367a-4e01-bc8f-babdd69557af","id":"1a50de91-367a-4e01-bc8f-babdd69557af","name":"apalo.io","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"c031379c-059c-425d-9dba-87e58acc3ab7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ebdc8116-a571-4ad0-899c-abde53ae8eb6","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.apalo.io/v1"},{"key":"spid","value":""},{"key":"apiToken","value":""},{"key":"iccid","value":"8944120006612345678"}]}