JAjambonz
Carriers

create a carrier as a service provider

Changed on

<Error>This endpoint is only availble with an Admin or Service Provider API key</Error>

post/ServiceProviders/{ServiceProviderSid}/VoipCarriers

Request

Request body

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

Example request

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

Response

service provider successfully created

sidstring required

Example response

{
  "sid": "9d26a637-1679-471f-8da8-7150266e1254"
}

Changes

  • cda83ab34ad0Revision changes
    • warning

      the request property's maxLength was set to 64

    • warning

      the request property's maxLength was set to 64

    • info

      added the new optional request property

  • 3b6ab0c10627Revision changes
    • breaking

      added the new required request property

    • warning

      removed the request property