Get received text messages

Get received text messages

Get received text messages

get

Get received text messages This API call returns one page of up to 250 received text messages. You can get either the most recent messages, or get older messages by specifying a particular notification ID in the older_than argument. You can only get the data for messages that are 7 days old or newer. Enable received text messages To receive text messages:

1. Go to the Text message settings section of the Settings page.

2. Select Change on the Receive text messages row.

Authorizations

BearerAuth

AuthorizationstringRequired

The authorisation header is an API key that is encoded using JSON Web Tokens. You must include an authorisation header.

JSON Web Tokens have a standard header and a payload. The header consists of:

{
   "type":"JWT",
   "alg":"HS256"
}

The payload consists of:

{
   "iss": "26785a09-ab16-4eb0-8407-a37497a57506",
   "iat": 1568818578
}

JSON Web Tokens are encoded using a secret key with the following format: 3d844edf-8d35-48ac-975b-e847b4f122b0

That secret key forms a part of your API key, which follows the format

{key_name}-{iss-uuid}-{secret-key-uuid}.

For example, if your API key is

my_test_key-26785a09-ab16-4eb0-8407-a37497a57506-3d844edf-8d35-48ac-975b-e847b4f122b0:

• your API key name is my_test_key
• your iss (your service id) is 26785a09-ab16-4eb0-8407-a37497a57506
• your secret key is 3d844edf-8d35-48ac-975b-e847b4f122b0

iat (issued at) is the current time in UTC in epoch seconds. The token expires within 30 seconds of the current time.

Refer to the JSON Web Tokens website for more information on encoding your authorisation header.

When you have an encoded and signed token, add that token to a header as follows:

"Authorization": "Bearer encoded_jwt_token"

Query parameters

older_thanstringOptional

The ID of a received text message. If this is passed, the response will only list text messages received before that message.

Responses

200

Success

application/json

Recieved text messages

400

Bad request. Check the message in the response to find out why your request failed.

application/json

403

Auth error. Check the message in the response to find out why your request failed.

application/json

404

Result not found. Check the message in the response to find out why your request failed.

application/json

get

/v2/received-text-messages

HTTPcURLJavaScriptPython

GET /v2/received-text-messages HTTP/1.1
Host: api.notifynl.nl
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "received_text_messages": [
    {
      "id": "740e5834-3a29-46b4-9a6f-16142fde533a",
      "created_at": "2024-05-17T15:58:38.342838Z",
      "service_id": "STRING",
      "notify_number": "STRING",
      "user_number": "STRING",
      "content": "STRING"
    }
  ],
  "links": {
    "current": "https://api.notifynl.nl/v2/received-text-messages",
    "next": "https://api.notifynl.nl/v2/received-text-messages?older_than=last_id_in_list"
  }
}