Get broadcastClient resource - Amply - Documentation

Get broadcastClient resource

curl --request GET \
  --url https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId} \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId}"

headers = {"X-API-KEY": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId}', 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.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$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.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId}"

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

	req.Header.Add("X-API-KEY", "<api-key>")

	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.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId}")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId}")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

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

{
  "_id": "64b7f8b6f23a4a4f3d0a9b12",
  "_createdAt": "2024-01-01T00:00:00.000Z",
  "email": "[email protected]",
  "platform": "web",
  "FCMToken": "string",
  "subscribed": true,
  "isAmply": true,
  "metadata": {},
  "_updatedAt": "2024-01-01T00:00:00.000Z",
  "_reference": "string"
}

GET

/

v1

/

users

/

{userId}

/

broadcasts

/

{broadcastId}

/

broadcastClients

/

{broadcastClientId}

Get broadcastClient resource

curl --request GET \
  --url https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId} \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId}"

headers = {"X-API-KEY": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId}', 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.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$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.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId}"

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

	req.Header.Add("X-API-KEY", "<api-key>")

	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.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId}")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.amply-app.com/v1/users/{userId}/broadcasts/{broadcastId}/broadcastClients/{broadcastClientId}")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

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

{
  "_id": "64b7f8b6f23a4a4f3d0a9b12",
  "_createdAt": "2024-01-01T00:00:00.000Z",
  "email": "[email protected]",
  "platform": "web",
  "FCMToken": "string",
  "subscribed": true,
  "isAmply": true,
  "metadata": {},
  "_updatedAt": "2024-01-01T00:00:00.000Z",
  "_reference": "string"
}

Authorizations

X-API-KEY

string

header

required

Use the format X-API-KEY YOUR_API_KEY. Each key is tied to a single broadcast.

Path Parameters

userId

string<objectId>

required

Resource identifier.

broadcastId

string<objectId>

required

Resource identifier.

broadcastClientId

string<objectId>

required

Resource identifier.

Response

200 - application/json

Success

_id

string<objectId>

required

Example:

"64b7f8b6f23a4a4f3d0a9b12"

_createdAt

string<date-time>

required

Example:

"2024-01-01T00:00:00.000Z"

email

string<email> | null

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Example:

"[email protected]"

platform

enum<string> | null

Available options:

web,

android,

ios

Example:

"web"

FCMToken

string | null

Example:

"string"

subscribed

boolean | null

Example:

true

isAmply

boolean | null

Example:

true

metadata

object

Show child attributes

_updatedAt

string<date-time> | null

Example:

"2024-01-01T00:00:00.000Z"

_reference

string | null

Example:

"string"

⌘I