get all carriers for an account

GET

https://api.jambonz.cloud/v1/Accounts/:AccountSid/VoipCarriers

GET

/v1/Accounts/:AccountSid/VoipCarriers

$ curl https://api.jambonz.cloud/v1/Accounts/AccountSid/VoipCarriers \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 [
2   {
3     "service_provider_sid": "6072f617-6151-4c15-8eb9-74a4967ab701",
4     "name": "Acme SIP Carrier",
5     "description": "Primary SIP carrier for US outbound calls",
6     "account_sid": "a3f1c2d4-5678-4b9a-9cde-123456789abc",
7     "application_sid": "b4d2e3f5-6789-4c0b-8def-23456789abcd",
8     "e164_leading_plus": true,
9     "requires_register": true,
10     "register_username": "acme_user",
11     "register_sip_realm": "sip.acmecarrier.com",
12     "register_password": "securePass123!",
13     "tech_prefix": "ACME",
14     "diversion": "enabled",
15     "is_active": true,
16     "smpp_system_id": "acme_smpp",
17     "smpp_password": "smppPass456!",
18     "smpp_inbound_system_id": "acme_inbound",
19     "smpp_inbound_password": "inboundPass789!",
20     "smpp_enquire_link_interval": 30,
21     "trunk_type": "auth",
22     "inbound_auth_username": "acme_inbound_user",
23     "inbound_auth_password": "inboundAuthPass!",
24     "voip_carrier_sid": "d9f8e7c6-b5a4-4321-9fed-cba987654321"
25   }
26 ]

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

AccountSidstringRequiredformat: "uuid"

Response

carrier listing

service_provider_sidstringformat: "uuid"

namestring

descriptionstringOptional

account_sidstringOptionalformat: "uuid"

application_sidstringOptionalformat: "uuid"

e164_leading_plusbooleanOptional

requires_registerbooleanOptional

register_usernamestringOptional

register_sip_realmstringOptional

register_passwordstringOptional

tech_prefixstringOptional

diversionstringOptional

is_activebooleanOptional

smpp_system_idstringOptional

smpp_passwordstringOptional

smpp_inbound_system_idstringOptional

smpp_inbound_passwordstringOptional

smpp_enquire_link_intervalintegerOptional

trunk_typeenumOptionalDefaults to static_ip

The type of trunk to create, see the guide for details

inbound_auth_usernamestringOptional<=64 characters

username for an auth trunk

inbound_auth_passwordstringOptional<=64 characters

password for an auth trunk

voip_carrier_sidstringOptionalformat: "uuid"

Errors

403

Forbidden Error

404

Not Found Error