NSns-api
SMS Numbers

Get SMS Numbers for User

Changed on
get/domains/{domain}/users/{user}/smsnumbers

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/domains/{domain}/users/{user}/smsnumbers
  • Auth
    HTTP bearer

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com
userstring required

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

Example:1000

Response

numberstring required

This is the SMS Number

applicationstring required

This is the application of the number. Can be for a user, callqueue, or available

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

carrierstring

This is the carrier the SMS number will send and receive messages through

deststring required

This is the destination for the SMS number if assigned. Can be a user or a call queue

mms-capableboolean

This is whether or not the SMS number can send MMS messages

group-mms-capableboolean

This is whether or not the SMS number can send group messages

Example response

[
  {
    "application": "user",
    "domain": "example.com",
    "dest": "1123"
  }
]

Changes

  • bce16087d479Revision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status