Carriers

retrieve voip carrier

get/VoipCarriers/{VoipCarrierSid}

Request

Base URL
https://api.jambonz.cloud/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/jambonz/apis/jambonz-api/docs/VoipCarriers/:VoipCarrierSid/get.ts
A function with typed inputs. Its response is checked against the schema.

voip carrier found

service_provider_sidstring uuid required

namestring required

descriptionstring

account_sidstring uuid

application_sidstring 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_type'static_ip' | 'auth' | 'reg'

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

inbound_auth_usernamestring

username for an auth trunk

inbound_auth_passwordstring

password for an auth trunk

{
  "service_provider_sid": "6072f617-6151-4c15-8eb9-74a4967ab701",
  "name": "my carrier"
}

Nov 8, 2025cda83ab34ad0 Revision changes
- info
  added the optional property to the response with the status
Sep 19, 20253b6ab0c10627 Revision changes
- breaking
  removed the required property from the response with the status
- info
  added the required property to the response with the status