NSns-api
Messages/SMS Block

Read SMS Blocks for Domain

Changed on
get/domains/{domain}/smsblocks

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/domains/{domain}/smsblocks
  • 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

Response

idstring required

The ID for the SMS block . Will be auto generated on addition

requesting-numberstring e164 required

This is the number that is requesting the block be added against the blocked-number.

blocked-numberstring e164 required

This is the number that will be blocked from sending new SMS to the requesting-number

domainstring required

Domain owning this block

status'active' | 'inactive'

active/inactive

created-datetimestring date-time
last-modified-datetimestring date-time

Example response

[
  {
    "requesting-number": "+18585551234",
    "blocked-number": "+18585551234"
  }
]

Changes