List broadcast contacts

GET

broadcasts

{broadcastId}

contacts

curl --request GET \
  --url https://api.zavu.dev/v1/broadcasts/{broadcastId}/contacts \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.zavu.dev/v1/broadcasts/{broadcastId}/contacts', 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.zavu.dev/v1/broadcasts/{broadcastId}/contacts",
  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.zavu.dev/v1/broadcasts/{broadcastId}/contacts"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.zavu.dev/v1/broadcasts/{broadcastId}/contacts")

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

{
  "items": [
    {
      "id": "<string>",
      "recipient": "<string>",
      "recipientType": "phone",
      "status": "pending",
      "createdAt": "2023-11-07T05:31:56Z",
      "templateVariables": {},
      "templateButtonVariables": {},
      "templateHeaderVariables": {},
      "messageId": "<string>",
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "cost": 123,
      "processedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>"
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

Authorizations

Authorization

string

header

required

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

Path Parameters

broadcastId

string

required

Query Parameters

status

enum<string>

Status of a contact within a broadcast.

pending, queued, sending: not handed to the provider yet.
sent: accepted by the provider; delivery is not confirmed yet. Channels that never report delivery leave the recipient here.
delivered: the channel confirmed delivery to the device. A WhatsApp read receipt also counts as delivered.
failed: not delivered. A recipient can move from sent or delivered to failed when the provider reports a failure late.
skipped: not sent, because the recipient opted out of the channel or the broadcast was cancelled before reaching it.

Available options:

pending,

queued,

sending,

sent,

delivered,

failed,

skipped

limit

integer

default:50

Required range: x <= 100

cursor

string

Response

List of broadcast contacts.

items

object[]

required

Show child attributes

nextCursor

string | null

⌘I

List broadcast contacts

curl --request GET \
  --url https://api.zavu.dev/v1/broadcasts/{broadcastId}/contacts \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.zavu.dev/v1/broadcasts/{broadcastId}/contacts', 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.zavu.dev/v1/broadcasts/{broadcastId}/contacts",
  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.zavu.dev/v1/broadcasts/{broadcastId}/contacts"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.zavu.dev/v1/broadcasts/{broadcastId}/contacts")

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

{
  "items": [
    {
      "id": "<string>",
      "recipient": "<string>",
      "recipientType": "phone",
      "status": "pending",
      "createdAt": "2023-11-07T05:31:56Z",
      "templateVariables": {},
      "templateButtonVariables": {},
      "templateHeaderVariables": {},
      "messageId": "<string>",
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "cost": 123,
      "processedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>"
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}