Cancel verifications by destination

Cancels every verification sent to destination. Note the response body is an array containing a single object.

POST

https://app.touchsms.com.au/api/v3/verify/cancel-by

Authorization

basicAuth
HTTP
required

Request body JSON required

destination
string
required
The number being verified, in the same format used when the verification was created.

Returns

200

Number of verifications cancelled.

JSON

data
optional
object
- cancelled_count
  optional
  integer
}

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

422

The request failed validation. errors lists the messages for each invalid field.

JSON

message
optional
string
errors
optional
map of
array<string>

Cancel verifications by destination

curl --request POST \
  --url https://app.touchsms.com.au/api/v3/verify/cancel-by \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination": "+61412345678"
}
'

const url = 'https://app.touchsms.com.au/api/v3/verify/cancel-by';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Basic <credentials>'},
  body: JSON.stringify({destination: '+61412345678'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://app.touchsms.com.au/api/v3/verify/cancel-by"

payload = { "destination": "+61412345678" }
headers = {
    "Content-Type": "application/json",
    "Authorization": "Basic <credentials>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

[
  {
    "data": {
      "cancelled_count": 2
    }
  }
]

{
  "message": "Unauthenticated."
}

{
  "message": "The messages field is required.",
  "errors": {
    "messages": [
      "The messages field is required."
    ]
  }
}