×
    • API authentication required
    Authorize Access
    Need API Access?

    Please use ‘Create Account’ to quickly register and start exploring our APIs

    GET

    https://<your_api_key>:<your_api_token><subdomain>/v2_beta/Accounts/<your_sid>/AvailablePhoneNumbers

    Response Content Type
  • Try it Now
    • GET

    https://<your_api_key>:<your_api_token><subdomain>/v2_beta/Accounts/<your_sid>/AvailablePhoneNumbers/<ISOCountryCode>/Landline

    To get a list of all the ExoPhones for a give ISO Country Code & Type, you need to make an HTTP GET request

    Parameter
    Name
    Value
    Description
    * ISOCountryCode
    path

    The ISO 3166-1 alpha-2 country code

    * IncomingSMS
    query

    Get only numbers that support incoming SMS.

    * InRegion
    query

    Get only numbers in the specified telecom circle. This filter is not applicable in all countries. For India, the currently supported regions are:

    • AP – Andhra Pradesh Circle

    • AS – Assam

    • BR – Bihar

    • DL – Delhi Circle

    • GJ – Gujarat

    • HP – Himachal Pradesh

    • HR – Haryana

    • JK – Jammu and Kashmir

    • KA – Karnataka Circle

    • KL – Kerala

    • KO – Kolkata

    • MH – Maharashtra

    • MP – Madhya Pradesh

    • MU – Mumbai Circle

    • NE – North East

    • OR – Orissa

    • PB – Punjab

    • RJ – Rajasthan

    • TN – Tamilnadu

    • UE – Uttar Pradesh East

    • UW – Uttar Pradesh West

    • WB – West Bengal

    * Contains
    query

    Get numbers that contains the specified substring.

    Response Content Type
  • Try it Now
    • POST

    https://<your_api_key>:<your_api_token><subdomain>/v2_beta/Accounts/<your_sid>/IncomingPhoneNumbers

    To begin using a new ExoPhone, make an HTTP POST request

    Parameter
    Name
    Value
    Description
    * PhoneNumber
    formData

    The ExoPhone that you wish to get.

    * VoiceUrl
    formData

    The VoiceURL to be associated to this number. The URL is of the form: http://my.exotel.com/{your_sid}/exoml/start_voice/{app_id} where app_id is the identifier of the flow (or applet) that you want to connect to once the From number picks up the call. You can get the app_id from your Exotel Dashboard.

    * SMSUrl
    formData

    The SMSUrl to be associated to this number. The URL is of the form: http://my.exotel.com/{your_sid}/exoml/start_sms/{app_id} where app_id is the identifier of the flow (or applet) that you want to connect to once an incoming SMS is received.

    * FriendlyName
    formData

    A friendly name that can be used to identify this number easily.

    Response Content Type
  • Try it Now
    • PUT

    https://<your_api_key>:<your_api_token><subdomain>/v2_beta/Accounts/<your_sid>/IncomingPhoneNumbers/<exophone_sid>

    To assign an ExoPhone to a flow you need to make a HTTP PUT request to:

    Parameter
    Name
    Value
    Description
    * exophone_sid
    path

    Exophone Sid

    * VoiceUrl
    formData

    The VoiceURL to be associated to this number. The URL is of the form: http://my.exotel.com/{your_sid}/exoml/start_voice/{app_id}

    * SMSUrl
    formData

    The SMSUrl to be associated to this number. The URL is of the form: http://my.exotel.com/{your_sid}/exoml/start_sms/{app_id} where app_id is the identifier of the flow (or applet) that you want to connect to once an incoming SMS is received.

    * FriendlyName
    formData

    A friendly name that can be used to identify this number easily.

    Response Content Type
  • Try it Now
    • GET

    https://<your_api_key>:<your_api_token><subdomain>/v2_beta/Accounts/<your_sid>/AvailablePhoneNumbers

    Response Content Type
  • Try it Now
    • GET

    https://<your_api_key>:<your_api_token><subdomain>/v2_beta/Accounts/<your_sid>/IncomingPhoneNumbers/<exophone_sid>

    To get the details of a specific ExoPhone number of an account, make an HTTP GET request

    Parameter
    Name
    Value
    Description
    * exophone_sid
    path
    Response Content Type
  • Try it Now
    • DELETE

    https://<your_api_key>:<your_api_token><subdomain>/v2_beta/Accounts/<your_sid>/IncomingPhoneNumbers/<exophone_sid>

    To release a number from your account, you need to make a HTTP DELETE request to:

    Parameter
    Name
    Value
    Description
    * exophone_sid
    path

    The sid is the unique identifier of the number

    Response Content Type
  • Try it Now