Sign in
Carriers

create a carrier as a service provider

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

post/ServiceProviders/{ServiceProviderSid}/VoipCarriers

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

Changed in 4 of the 27 revisions of this API.233

  • cda83ab34ad021See the full diff
    • ●

      the inbound_auth_password request property's maxLength was set to 64

      request-property-max-length-set

    • ●

      the inbound_auth_username request property's maxLength was set to 64

      request-property-max-length-set

    • ○

      added the new optional request property trunk_type

      new-optional-request-property

  • 3b6ab0c1062711See the full diff
    • ▲

      added the new required request property service_provider_sid

      new-required-request-property

    • ●

      removed the request property voip_carrier_sid

      request-property-removed

  • d813879165bf1See the full diff
    • ▲

      the smpp_enquire_link_interval request property type/format changed from number/integer to integer/

      request-property-type-changed

  • 087165ecc0672See the full diff
    • ○

      api tag Carriers added

      api-tag-added

    • ○

      api tag Service Providers removed

      api-tag-removed