Skip to content

Latest commit

 

History

History
94 lines (94 loc) · 2.95 KB

Retrieve list of phone numbers in blacklist.md

File metadata and controls

94 lines (94 loc) · 2.95 KB

Retrieve list of phone numbers in blacklist

Retrieve the paginated list of Phone numbers in SMS Blacklist

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user token sections.
All the query string parameters in URL must be UTF-8 URL Encoded.

HTTP Headers

user_key / Session_key

HTTP Method

GET

HTTP Request

https://app.gateway.smsend.it/API/v1.0/REST/blacklist/sms

Parameters

Parameter Type Description Required Default
from Date(yyyy-MM-dd HH:mm:ss) Return results from the given date No -
to Date(yyyy-MM-dd HH:mm:ss) Return results up to the given date No -
timezone Timezone(IANA time zone) Optional timezone applied to from or to dates No -
number String Return results that contains this phone number or part of it. No -
origins String List of origins(API, WEB, STOPSMS) separated by ‘,’ used for filter the results No -
pageNumber String Return the given results page No -
pageSize String The number of results in a page No -
If one or more phone numbers are badly formatted, no numbers will be put in blacklist, and the response will have http status 400

Returns

Code Description
200 A paginated list of phone number in blacklist.
400 Some of the parameters specified were badly formatted
401 [Unauthorized] User_key, Token or Session_key are invalid or not provided
404 [Not found] The User_key was not found