List subscription phone number events

GET

notify

management

subscriptions

{config_id}

phone_numbers

{phone_number}

events

List subscription phone number events

curl --request GET \
  --url https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "events": [
    {
      "config_id": "subcfg_01k8ap1btqf5r9fq2c8ax5fhc9",
      "phone_number": "+33612345678",
      "state": "SUB",
      "source": "MO_KEYWORD",
      "timestamp": "2024-01-01T12:00:00Z",
      "reason": "STOP"
    }
  ],
  "next_cursor": "eyJwayI6IjEyMzQ1Njc4LTkwYWItMTJjZC00NTY3LTg5MGFiMTJjZGU0NTYifQ=="
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

config_id

string

required

The subscription configuration ID

phone_number

string

required

The phone number in E.164 format (e.g., +33612345678)

Query Parameters

limit

integer

default:50

Maximum number of events to return per page

Required range: 1 <= x <= 200

cursor

string

Pagination cursor from the previous response

Response

events

object[]

required

A list of subscription events (status changes) ordered by timestamp descending.

Show child attributes

next_cursor

string

Pagination cursor for the next page of results. Omitted if there are no more pages.

Example:

"eyJwayI6IjEyMzQ1Njc4LTkwYWItMTJjZC00NTY3LTg5MGFiMTJjZGU0NTYifQ=="

List subscription phone number events

curl --request GET \
  --url https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/notify/management/subscriptions/{config_id}/phone_numbers/{phone_number}/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "events": [
    {
      "config_id": "subcfg_01k8ap1btqf5r9fq2c8ax5fhc9",
      "phone_number": "+33612345678",
      "state": "SUB",
      "source": "MO_KEYWORD",
      "timestamp": "2024-01-01T12:00:00Z",
      "reason": "STOP"
    }
  ],
  "next_cursor": "eyJwayI6IjEyMzQ1Njc4LTkwYWItMTJjZC00NTY3LTg5MGFiMTJjZGU0NTYifQ=="
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a"
}

Documentation

API Reference

List subscription phone number events

Authorizations

Path Parameters

Query Parameters

Response