GET /virtual-numbers/{virtual-number}/optouts

telstra.com

Summary: Get recipient optouts list
Operation ID: getRecipientOptouts
Auth: unknown
Description

Use this endpoint to fetch any mobile number(s) that have opted out of receiving messages from a Virtual Number assigned to your account. Recipients can opt out at any time by sending a message with industry standard keywords such as STOP, STOPALL, UNSUBSCRIBE, QUIT, END and CANCEL.

Parameters (9)

Accept (string, header, required)
Accept-Charset (string, header, required)
Authorization (string, header, required)
Content-Language (string, header, required)
Content-Type (string, header, required)
Telstra-api-version (string, header, optional)
limit (integer, query, optional, default: 10)

Tell us how many results you want us to return, up to a maximum of 50.

Constraints: {'minimum': 1, 'maximum': 50}

offset (integer, query, optional, default: 0)

Use the offset to navigate between the response results. An offset of 0 will display the first page of results, and so on.

Constraints: {'minimum': 0, 'maximum': 999999}

virtual-number (string, path, required)

Write the Virtual Number here, using national format (e.g. 0412345678).

Constraints: {'minLength': 10, 'maxLength': 10}

No probe data for this endpoint yet.