retrieve voip carrier

curl https://api.jambonz.cloud/v1/VoipCarriers/VoipCarrierSid \
     -H "Authorization: Bearer <token>"

{
  "service_provider_sid": "6072f617-6151-4c15-8eb9-74a4967ab701",
  "name": "Acme VoIP Carrier",
  "description": "Primary SIP carrier for North America region",
  "account_sid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "application_sid": "123e4567-e89b-12d3-a456-426614174000",
  "e164_leading_plus": true,
  "requires_register": true,
  "register_username": "acme_user",
  "register_sip_realm": "sip.acmevoip.com",
  "register_password": "securePass!2024",
  "tech_prefix": "99",
  "diversion": "true",
  "is_active": true,
  "smpp_system_id": "acme_smpp",
  "smpp_password": "smppPass123",
  "smpp_inbound_system_id": "acme_inbound",
  "smpp_inbound_password": "inboundPass456",
  "smpp_enquire_link_interval": 30,
  "trunk_type": "static_ip",
  "inbound_auth_username": "inboundUser",
  "inbound_auth_password": "inboundSecret"
}

Authentication

AuthorizationBearer

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

Path parameters

VoipCarrierSidstringRequired

Response

voip carrier found

service_provider_sidstringformat: "uuid"

namestring

descriptionstring

account_sidstringformat: "uuid"

application_sidstringformat: "uuid"

e164_leading_plusboolean

requires_registerboolean

register_usernamestring

register_sip_realmstring

register_passwordstring

tech_prefixstring

diversionstring

is_activeboolean

smpp_system_idstring

smpp_passwordstring

smpp_inbound_system_idstring

smpp_inbound_passwordstring

smpp_enquire_link_intervalinteger

trunk_typeenumDefaults to static_ip

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

Allowed values:

inbound_auth_usernamestring<=64 characters

username for an auth trunk

inbound_auth_passwordstring<=64 characters

password for an auth trunk

Errors

404

Not Found Error

500

Internal Server Error