Skip to main content
GET
Obtenir les comptes d'un canal

Supported products

Autorisations

Authorization
string
header
requis

The access token received from the authorization server in the OAuth 2.0 flow.

Paramètres de chemin

channelId
integer<int32>
requis

L'identifiant unique du canal pour lequel lister les comptes.

Paramètres de requête

after
string

Le jeton de curseur de pagination de la dernière ressource lue avec succès sera renvoyé en tant que propriété JSON paging.next.after d'une réponse paginée contenant plus de résultats.

archived
boolean

S'il faut renvoyer uniquement les résultats qui ont été archivés.

defaultPageLength
integer<int32>

Le nombre par défaut de résultats à afficher par page.

deliveryIdentifierType
enum<string>[]

Un tableau de types d'identifiants de livraison pour filtrer les résultats. Les valeurs valides incluent HS_EMAIL_ADDRESS, HS_PHONE_NUMBER, HS_SHORT_CODE et CHANNEL_SPECIFIC_OPAQUE_ID.

Options disponibles:
HS_EMAIL_ADDRESS,
HS_PHONE_NUMBER,
HS_SHORT_CODE,
CHANNEL_SPECIFIC_OPAQUE_ID
deliveryIdentifierValue
string[]

Un tableau de valeurs d'identifiants de livraison pour filtrer les résultats.

limit
integer<int32>

Le nombre maximum de résultats à afficher par page.

sort
string[]

Un tableau spécifiant l'ordre de tri des résultats.

Réponse

successful operation

results
object[]
requis

Un tableau d'objets PublicChannelAccount, chacun représentant un compte de canal public avec ses détails.

total
integer<int32>
requis

Un entier représentant le nombre total de comptes de canaux publics disponibles.

paging
object

Représente les informations de pagination pour naviguer dans une liste de résultats de l'API. Il fournit des détails sur la manière d'accéder à l'ensemble de résultats précédent ou suivant.

Dernière modification le 6 octobre 2026