Pular para o conteúdo principal
GET
Obter contas para um canal

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

channelId
integer<int32>
obrigatório

O identificador exclusivo do canal para o qual listar as contas.

Parâmetros de consulta

after
string

O token do cursor de paginação do último recurso lido será retornado como a propriedade JSON paging.next.after de uma resposta paginada que contém mais resultados.

archived
boolean

Se apenas os resultados que foram arquivados devem ser retornados.

defaultPageLength
integer<int32>

O número padrão de resultados a serem exibidos por página.

deliveryIdentifierType
enum<string>[]

Uma matriz de tipos de identificadores de entrega para filtrar os resultados. Os valores válidos incluem HS_EMAIL_ADDRESS, HS_PHONE_NUMBER, HS_SHORT_CODE e CHANNEL_SPECIFIC_OPAQUE_ID.

Opções disponíveis:
HS_EMAIL_ADDRESS,
HS_PHONE_NUMBER,
HS_SHORT_CODE,
CHANNEL_SPECIFIC_OPAQUE_ID
deliveryIdentifierValue
string[]

Uma matriz de valores de identificador de entrega para filtrar os resultados.

limit
integer<int32>

O número máximo de resultados a serem exibidos por página.

sort
string[]

Uma matriz que especifica a ordem de classificação dos resultados.

Resposta

successful operation

results
object[]
obrigatório

Uma matriz de objetos PublicChannelAccount, cada um representando uma conta de canal público com seus detalhes.

total
integer<int32>
obrigatório

Um número inteiro que representa o número total de contas de canais públicos disponíveis.

paging
object

Representa as informações de paginação para navegar por uma lista de resultados na API. Ele fornece detalhes sobre como acessar o conjunto anterior ou seguinte de resultados.

Última modificação em 6 de outubro de 2026