Show virtual phone number information
Request
GET https://api.46elks.com/a1/numbers/{id}
Response structure
Example JSON response
{
"id": "n57c8f48af76bf986a14f251b35389e8b",
"active": "yes",
"country": "se",
"number": "+46766861001",
"capabilities": [ "sms", "voice", "mms" ],
"sms_url": "https://yourapp.example/elks/sms",
"mms_url": "https://yourapp.example/elks/mms",
"voice_start": "https://yourapp.example/elks/calls",
}
Parameter |
Type |
Description |
id |
string |
ID of the allocated number |
active |
string |
If the number is active or not, allways "yes" on newly allocated numbers |
country |
string |
A two-letter (ISO alpha 2) country code. |
number |
string |
The phone number in E.164 format. |
capabilities |
list |
A comma-seperated string denoting the capabilities the number should have. For example "sms", "sms,voice" or "sms,mms,voice". |
sms_url |
string |
If the has SMS support this url it where the API will send incomming SMS. |
voice_start |
string |
If the has Voice support this url it where the API will send incomming calls to be handeled. |
mms_url |
string |
If the has MMS support this url it where the API will send incomming MMS. |