Solicitação de Texto
A Solicitação de Texto é uma plataforma de texto empresarial criada para inflamar o envolvimento do cliente. Criamos uma solução de mensagens plug-and-play para seus problemas de comunicação diários, para que você possa cortar o ruído e se conectar com os clientes a qualquer momento, em qualquer lugar. Saiba mais sobre como ajudamos líderes empresariais ocupados como você.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte à API de Solicitação de Texto |
| URL | https://www.textrequest.com/contact |
| apidev@textrequest.com |
| Metadados do conector | |
|---|---|
| Publicador | Solicitação de Texto |
| Site | https://www.textrequest.com/ |
| Política de privacidade | https://www.textrequest.com/privacy-policy/ |
| Categorias | Comunicação; Vendas e CRM |
Aranda Service Management Suite (ASMS)
Aumente a produtividade da sua empresa e transforme a experiência dos usuários com o Aranda Service Management Suite, a solução multilocatário que permite gerenciar, integrar e automatizar processos e serviços de negócios. Crie, pesquise e atualize registros armazenados em qualquer workspace (projeto) do ASMS, incluindo incidentes, requisitos e alterações, entre outros.
Pré-requisitos
Tenha em mente os seguintes pré-requisitos para continuar:
- Uma assinatura e uma instância do Aranda Service Management Suite (ASMS). Comece aqui: https://arandasoft.com/
- Uma assinatura ativa do Microsoft Power Automate com recursos de conector Premium.
Obtendo credenciais
- Para executar a autenticação, use o token de integração. No link a seguir, você encontrará informações sobre como obter o token de integração
Introdução ao conector
Requer uma assinatura do ASMS (Aranda Service Management Suite).
Obter o token de integração
Obtenha a URL da Instância da API asms (ApiAsms) de Gerenciamento de Serviços do Aranda.
Estabeleça uma conexão com o conector do Aranda Service Management Suite.
Selecione uma das seguintes funções oferecidas pelo conector:
Para obter uma documentação detalhada em torno do conector, consulte https://docs.arandasoft.com/connectors
Você pode usar esse conector nos seguintes casos:
- Crie, pesquise e atualize tíquetes, entre outras ações disponíveis.
- Obter a rastreabilidade do tíquete.
- Baixe anexos relacionados a um tíquete.
- Pesquise artigos de KB (base de dados de conhecimento) no Aranda Service Management Suite.
- Baixe anexos de artigos da base de dados de conhecimento (KB).
- Criar, pesquisar e atualizar itens de configuração (CIs).
- Ele permite que as organizações resolvam suas solicitações internas de suporte, gerenciando e simplificando o processo de resolução de problemas técnicos.
- Permite o acompanhamento de comunicações entre solicitantes e agentes de suporte.
- Ofereça respostas automatizadas para informar os solicitantes sobre o status de seu tíquete.
Resposta bem-sucedida
| Code | Nome | Description |
|---|---|---|
| 200 | OKEY | A solicitação foi bem-sucedida |
| 204 | Sem conteúdo | Nenhum dado encontrado na solicitação |
Erros e soluções comuns
| Code | Nome | Description | Solução |
|---|---|---|---|
| 400 | SolicitaçãoInválida | CriteriaNeedsSomeArguments | Verifique se os parâmetros de pesquisa não estão vazios |
| 400 | SolicitaçãoInválida | InvalidAdditionalFieldId | Verifique se as IDs dos campos adicionais estão corretas |
| 400 | SolicitaçãoInválida | InvalidItemType | O tipo de caso está incorreto, altere a ID do tipo de caso |
| 400 | SolicitaçãoInválida | InvalidProjectId | A ID do projeto está incorreta, altere a ID do projeto à qual você associará o caso |
| 400 | SolicitaçãoInválida | InvalidStateId | Verificar o status adicionado ao criar ou atualizar um tíquete |
| 400 | SolicitaçãoInválida | InvalidUploadType | Erro ao anexar um arquivo, solicitar assistência de um Administrador do Sistema |
| 400 | SolicitaçãoInválida | RequestNeedsSomeArguments | Verifique os campos necessários do tíquete e adicione o valor correspondente destes no conector |
| 400 | SolicitaçãoInválida | SearchListIsRequired | Solicitar assistência de um Administrador do Sistema |
| 400 | SolicitaçãoInválida | Nome do parâmetro: {Parâmetro de nome} | Verifique se as propriedades mencionadas no erro não são nulas |
| 400 | SolicitaçãoInválida | É o nome do parâmetro nulo: {Parâmetro de nome} | Verifique se as propriedades mencionadas no erro não são nulas |
| 400 | SolicitaçãoInválida | ItemTypeIsRequired | Adicionar tipo de caso |
| 400 | SolicitaçãoInválida | ModelIdIsEmpty | Adicione o parâmetro modelId. É necessário. |
| 400 | SolicitaçãoInválida | StateIdIsEmpty | Adicione o parâmetro stateId. É necessário. |
| 400 | SolicitaçãoInválida | ServiceIdIsEmpty | Adicione o parâmetro serviceId. É necessário. |
| 400 | SolicitaçãoInválida | CategoryIdIsEmpty | Adicione o parâmetro categoryId. É necessário. |
| 400 | SolicitaçãoInválida | TypesListNeedsSomeArguments | Requer a adição do tipo de caso ao pesquisar tíquetes, solicitar assistência de um Administrador do Sistema |
| 400 | SolicitaçãoInválida | '{PARAMETER_NAME}' AdditionalFieldIsRequired | O campo adicional '{PARAMETER_NAME}' é obrigatório |
| 400 | SolicitaçãoInválida | ModelNotActive | O modelo associado ao caso não está ativo |
| 400 | SolicitaçãoInválida | FailedToCloseTaskPendingCloseTasksPredecessors | Se você tentar fechar o caso e o caso pai tiver tarefas pendentes para fechar |
| 400 | SolicitaçãoInválida | DuplicatedObject | O Ci já existe no banco de dados |
| 400 | SolicitaçãoInválida | Nome do parâmetro EmptyValue: {PARAMETER_NAME} | O parâmetro {PARAMETER_NAME} é necessário |
| 400 | SolicitaçãoInválida | Nome do parâmetro EmptyEnumeration: {PARAMETER_NAME} | O parâmetro {PARAMETER_NAME} é uma lista e é necessário |
| 403 | Proibido | DoNotHavePermissionForThisAction | Fale com o Administrador do Sistema para atribuir permissões |
| Code | Nome | Description | Solução |
|---|---|---|---|
| 500 | Erro Interno do Servidor | Solicitar assistência de um Administrador do Sistema | |
| 500 | Erro Interno do Servidor | FailureExportExcel | Solicitar assistência de um Administrador do Sistema |
| 500 | Erro Interno do Servidor | FailureGetAdditionalFields | Solicitar assistência de um Administrador do Sistema |
| 500 | Erro Interno do Servidor | FailureGetCategoriesByService | Solicitar assistência de um Administrador do Sistema |
| 500 | Erro Interno do Servidor | FailureGetChangeFSC | Solicitar assistência de um Administrador do Sistema |
| 500 | Erro Interno do Servidor | FailureGetFields | Solicitar assistência de um Administrador do Sistema |
| 500 | Erro Interno do Servidor | FailureGetFieldsList | Solicitar assistência de um Administrador do Sistema |
| 500 | Erro Interno do Servidor | FailureGetFiles | Solicitar assistência de um Administrador do Sistema |
| 500 | Erro Interno do Servidor | FailureGetLookupValues | Solicitar assistência de um Administrador do Sistema |
| 500 | Erro Interno do Servidor | FailureGetMailTemplates | Solicitar assistência de um Administrador do Sistema |
| 500 | Erro Interno do Servidor | FailureGetModelByCategory | Solicitar assistência de um Administrador do Sistema |
| 500 | Erro Interno do Servidor | FailureGetOperators | Solicitar assistência de um Administrador do Sistema |
| 500 | Erro Interno do Servidor | FailureGetReassignmentReasons | Solicitar assistência de um Administrador do Sistema |
| 500 | Erro Interno do Servidor | FailureGetSimilarItems | Solicitar assistência de um Administrador do Sistema |
| 500 | Erro Interno do Servidor | FailureSearchQuickManagement | Solicitar assistência de um Administrador do Sistema |
perguntas frequentes
Como recuperar as IDs dos atributos necessários para usar as diferentes ações no conector (por exemplo, projeto, serviço, categoria, grupo, especialista)?
As IDs podem ser recuperadas de várias maneiras:
- Usando o Aranda Query Manager, você pode criar um relatório que consulta a tabela ASMS (Aranda Service Management Suite), em que os dados necessários estão localizados. Se você precisar de diretrizes sobre os objetos de dados na solução, visite o link https://docs.arandasoft.com/docs/database.html a seguir e identifique a versão do banco de dados aranda correspondente à instalação do ASMS.
- Se você estiver usando uma instalação local do ASMS, poderá consultar a tabela ASMS em que os dados necessários estão localizados por meio de um cliente SQL.
- Por meio do Centro de Suporte do Aranda, criando uma solicitação de suporte por meio dos canais de contato indicados no suporte do site a seguir.
Qual é o tamanho máximo dos arquivos a serem anexados ao usar a ação "Adicionar Anexo"?
O tamanho máximo depende da configuração específica da instância/instalação do ASMS. Pergunte ao administrador do ASMS.
Qual é o nível de acesso a dados exigido pela conta técnica cujo token é usado na configuração da conexão ASMS exigida pelo conector?
O nível de acesso é o mesmo que a conta técnica usada no ASMS regularmente. Em outras palavras, com base nas funções e permissões do técnico correspondente no ASMS, os dados podem ser acessados com o conector.
A conta técnica cujo token será usado no conector deve ser Nomeada ou Simultânea?
Como o conector pode acessar a instância do ASMS relacionada várias vezes por hora, é altamente recomendável que a conta seja um tipo Nomeado.
A criação ou modificação de casos usando o conector segue as mesmas regras de validação de dados presentes na interface do ASMS?
Sim, ele segue as mesmas regras de validação. Por exemplo, ao criar um caso para um projeto, serviço e categoria específicos, se campos nativos e adicionais precisarem ser preenchidos, esses dados também serão necessários ao enviar o caso por meio do conector.
O conector pode ser usado para instâncias do ASMS em ambientes de nuvem e local?
Sim, ele pode ser usado nas instalações de nuvem e local do ASMS. Em instalações locais, você deve considerar a conectividade entre o servidor ASMS e seu ambiente do Power Automate.
Tenho uma licença do Power Automate que só me permite usar conectores Standard. Posso usar o conector do ASMS?
Não é possível, o conector do ASMS é do tipo Premium.
Quero criar fluxos no Power Automate que começam a partir de eventos no ASMS (por exemplo, quando um caso foi criado, quando um caso é atribuído a um grupo específico). É possível usar gatilhos que começam de eventos que ocorrem no ASMS?
Sim, é possível. As seguintes etapas são recomendadas:
- Inicialize um gatilho "Quando uma solicitação HTTP é recebida" e crie um esquema JSON do corpo da solicitação contendo a estrutura de dados que deverá ser recebida do ASMS. Depois que o gatilho for criado, você obterá uma URL HTTP POST (URL do WebHook) para usar em sua instância do ASMS. Não se esqueça de considerar o mecanismo de autenticação para acessar a URL do WebHook (por exemplo, Token).
- Crie uma regra de negócios no ASMS para o conjunto de condições que, quando atendidas, devem iniciar o fluxo no Power Automate. Como uma ação dentro da regra, selecione "Invocar Webhook" e, na URL de destino da invocação, insira a URL do WebHook obtida anteriormente, os parâmetros a serem enviados e o corpo da solicitação (que deve corresponder ao Esquema JSON do Corpo da Solicitação). Para obter mais informações sobre como invocar um Webhook de uma regra no ASMS, visite o seguinte link: regra do Webhook
- Teste a regra criada e valide se uma solicitação HTTP é enviada para a URL do WebHook e inicializa o fluxo no Power Automate.
Posso invocar pontos de extremidade da API REST do ASMS como ações de fluxos no Power Automate?
Sim, é possível. Use a ação "HTTP" e preencha os dados necessários nele (URI, Método, Cabeçalhos, Corpo, entre outros).
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | secureString | A chave de API para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Arquivar uma conversa |
Arquiva uma conversa, removendo-a dos resultados de todos os pontos de extremidade de recuperação de conversa. Uma conversa será desarquivada automaticamente se o cliente enviar um texto para o número da Solicitação de Texto ou se você enviar um texto do número da Solicitação de Texto ao cliente. Arquivar conversas é uma boa maneira de remover a desordem dos clientes com quem você não planeja conversar no futuro. Observe que, se um cliente enviar textos em "STOP" para impedir que você envie mensagens SMS adicionais, a conversa será arquivada automaticamente. |
| Atualiza um grupo com a ID fornecida |
Atualiza o nome de um grupo usando a ID numérica do grupo. Se a ID do grupo passada não existir, a chamada falhará. |
| Atualizar o nome de um painel específico |
Atualiza um painel. Isso não altera o número de telefone de um painel. Se você quiser um novo número com os contatos de outro painel, precisará criar um novo painel com um POST e adicionar os contatos com uma exportação/importação em massa. |
| Cancela o pagamento especificado |
Cancela o pagamento especificado, informando ao usuário que o pagamento foi cancelado. Os pagamentos não podem ser editados, portanto, cancelar e emitir um novo pagamento é a melhor maneira de corrigir um pagamento. |
| Contatos de atualização em massa |
Somente o painel especificado terá contatos adicionados; os contatos são organizados por painel e não há nenhuma pesquisa no nível da conta para um número disponível. |
| Cria um novo grupo |
Cria um novo grupo com o nome fornecido. |
| Cria um novo pagamento |
Cria um novo pagamento com a mensagem fornecida para o contato fornecido. |
| Criar ou atualizar um contato |
Cria ou atualiza um contato (dependendo se já existe um com o número de telefone especificado). |
| Criar um novo painel com o nome e o número de telefone fornecidos |
Cria um novo painel na conta. Depois que o painel for criado, os administradores serão enviados por e-mail sobre a alteração e poderão começar a atribuir usuários. Esse ponto de extremidade pode fazer um painel para todos os números provisionados. Você pode pesquisar números provisionados em um código de área específico usando GET /dashboards/provisionamento. Se o número de telefone já estiver em uso, uma exceção de Solicitação Inválida será gerada. |
| Desarquivar uma conversa |
Desarquiva uma conversa. Depois que uma conversa não for criada, ela será exibida novamente na fila. ele também será exibido em conversas retornadas pelo ponto de extremidade /conversations. Se uma conversa já não for pesquisada, esse método não terá efeito. |
| Enviar um texto de acompanhamento lembrando o usuário de pagar o pagamento especificado |
Envia um lembrete para o contato para pagar o pagamento especificado. O conteúdo da mensagem é gerado automaticamente. Para evitar spam, somente um lembrete pode ser enviado por pagamento |
| Enviar uma mensagem para o contato com o número de telefone especificado |
Envia uma mensagem (iniciando uma nova conversa se o número de telefone especificado não tiver histórico de mensagens). |
| Exclui o contato com o número de telefone especificado |
Exclui o contato com o número de telefone especificado |
| Exclui o grupo com a ID especificada |
Exclui o grupo com a ID especificada. Isso terá êxito mesmo se houver contatos que sejam membros do grupo (os contatos não serão excluídos). |
| Exclui o painel especificado |
Exclui o painel especificado. |
| Marcar um pagamento como pago |
Fecha um pagamento como "pago". Use esse ponto de extremidade para quando o pagamento for pago por meio de um meio diferente do portal de solicitação de pagamento. Isso fechará o pagamento e adicionará seu valor de pagamento às suas estatísticas. Esse ponto de extremidade não é necessário para pagamentos pagos por meio do portal de pagamentos enviado por meio da Solicitação de Texto; que marcará automaticamente um pagamento conforme pago. |
| Obter informações neste painel específico |
Retorna o nome e o telefone do painel. |
| Obter mensagens de uma conversa pelo número de telefone de um contato |
Obtenha a conversa entre o painel especificado e o número de telefone. |
| Obter todos os contatos que correspondem ao critério de filtragem especificado |
Obtém todos os contatos que correspondem ao critério de filtragem especificado. Somente o painel especificado será pesquisado; não há nenhuma pesquisa no nível da conta para um número disponível. |
| Obter todos os dashboards em uma conta |
Obtém todos os dashboards em uma conta. |
| Obter um grupo por sua ID |
Obtém o grupo com a ID especificada. |
| Obtém o contato com o número de telefone especificado |
Obtém o contato com o número de telefone especificado |
| Obtém o pagamento com a ID especificada |
Obtém o pagamento com a ID especificada. |
| Obtém todas as conversas para este painel |
Obtém todas as conversas para este painel e inclui informações sobre a última mensagem para cada conversa. |
| Obtém todas as marcas |
Obtém todas as marcas deste painel. As marcas são exclusivas entre dashboards. |
| Obtém todos os campos personalizados |
Obtém todos os campos personalizados para este painel. Os campos personalizados são exclusivos entre dashboards. |
| Obtém todos os grupos |
Obtém todos os grupos para a conta do usuário. |
| Obtém todos os pagamentos |
Obtém todos os pagamentos, incluindo pagamentos cancelados e pagos. Elas podem ser filtradas usando os parâmetros de consulta. |
Arquivar uma conversa
Arquiva uma conversa, removendo-a dos resultados de todos os pontos de extremidade de recuperação de conversa. Uma conversa será desarquivada automaticamente se o cliente enviar um texto para o número da Solicitação de Texto ou se você enviar um texto do número da Solicitação de Texto ao cliente. Arquivar conversas é uma boa maneira de remover a desordem dos clientes com quem você não planeja conversar no futuro. Observe que, se um cliente enviar textos em "STOP" para impedir que você envie mensagens SMS adicionais, a conversa será arquivada automaticamente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
Número de telefone da conversa
|
phone_number | True | string |
Número de telefone da conversa a ser arquivada. |
Retornos
- response
- string
Atualiza um grupo com a ID fornecida
Atualiza o nome de um grupo usando a ID numérica do grupo. Se a ID do grupo passada não existir, a chamada falhará.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
ID do grupo
|
group_id | True | integer |
A ID numérica do grupo a ser atualizado. |
|
Nome do grupo
|
name | string |
O novo nome do grupo. |
|
|
Nota de grupo
|
notes | string |
Frase curta que descreve o grupo. Usado para conveniência. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
A ID numérica do grupo. |
|
group_member_count
|
group_member_count | integer |
O número de membros do grupo. |
|
is_keyword
|
is_keyword | boolean |
Esse grupo é um grupo de palavras-chave. Esses grupos são gerados automaticamente quando um usuário configura uma palavra-chave. Os contatos são adicionados automaticamente quando se registram. |
|
nome
|
name | string |
O nome desse grupo. |
|
notas
|
notes | string |
Todas as anotações sobre esse grupo. |
|
last_message_sent_utc
|
last_message_sent_utc | string |
Carimbo de data/hora de quando a última mensagem de grupo foi enviada para esse grupo. |
Atualizar o nome de um painel específico
Atualiza um painel. Isso não altera o número de telefone de um painel. Se você quiser um novo número com os contatos de outro painel, precisará criar um novo painel com um POST e adicionar os contatos com uma exportação/importação em massa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
Nome do painel
|
name | string |
O novo nome do painel. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
A ID numérica do painel. |
|
nome
|
name | string |
O nome do painel. |
|
phone
|
phone | string |
O número de texto associado a este painel. |
Cancela o pagamento especificado
Cancela o pagamento especificado, informando ao usuário que o pagamento foi cancelado. Os pagamentos não podem ser editados, portanto, cancelar e emitir um novo pagamento é a melhor maneira de corrigir um pagamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
ID do pagamento
|
payment_id | True | integer |
A ID numérica do pagamento a ser atualizado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
payment_id
|
payment_id | integer |
A ID numérica do pagamento. |
|
request_date
|
request_date | string |
O carimbo de data/hora de quando a mensagem inicial desse pagamento foi enfileirada para ser enviada. |
|
destinatário
|
recipient | string |
O nome do destinatário do pagamento. Isso poderá ser nulo se o contato não tiver um nome associado ao seu número de telefone. |
|
descrição
|
description | string |
A descrição do pagamento. Isso não é mostrado ao contato. Ele só é usado por usuários internos para contexto sobre pagamentos. |
|
customer_phone
|
customer_phone | string |
O número de telefone do contato que está sendo enviado para esse pagamento. |
|
amount_requested
|
amount_requested | float |
O valor em dólares solicitados por esse pagamento. |
|
is_past_due
|
is_past_due | boolean |
Se esse pagamento já passou da data da solicitação. |
|
reminder_was_sent
|
reminder_was_sent | boolean |
Se um lembrete de texto já foi enviado para esse pagamento. |
|
transaction_status
|
transaction_status | string |
O status da transação na authvia. Esse valor começa como Desconhecido. |
|
textrequest_payment_status
|
textrequest_payment_status | string |
O status da transação na Solicitação de Texto. Isso representa o status mostrado na página de pagamentos no aplicativo Solicitação de Texto. Ele começa como Enviado. |
|
reference_number
|
reference_number | string |
A ID definida pelo usuário definida quando são criados pagamentos que podem ser usados para localizar pagamentos rapidamente. Os números de referência não são exclusivos; muitos pagamentos podem ter a mesma referência. |
Contatos de atualização em massa
Somente o painel especificado terá contatos adicionados; os contatos são organizados por painel e não há nenhuma pesquisa no nível da conta para um número disponível.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
Número de telefone de contato
|
phone_number | string |
Número de telefone do contato a ser criado ou atualizado. |
|
|
Nome do contato
|
first_name | string |
O novo nome do contato. |
|
|
Sobrenome do contato
|
last_name | string |
O novo sobrenome do contato. |
|
|
Nome completo do contato
|
display_name | string |
O novo nome completo do contato. Esse é o nome padrão exibido no aplicativo Web ao exibir contatos. |
|
|
Se as mensagens desse contato são suprimidas
|
is_suppressed | boolean |
Determina se as conversas com esse contato são suprimidas e, portanto, não enviadas por push para a parte superior da fila de mensagens quando recebidas. |
|
|
Se as mensagens desse contato são arquivadas
|
is_archived | boolean |
Determina se as conversas com esse contato são arquivadas e, portanto, não podem ser vistas ao consultar conversas (por padrão). |
|
|
Se as mensagens desse contato estão bloqueadas
|
is_blocked | boolean |
Determina se as conversas com esse contato estão bloqueadas e, portanto, não são recebidas ou armazenadas. |
|
|
Motivo para suprimir esse contato
|
suppressed_reason | string |
Frase que descreve o motivo para suprimir o contato. |
|
|
Nota de contato
|
note | string |
Frase curta que descreve o contato. Usado para conveniência. Isso nunca é mostrado ao contato. |
|
|
Grupos de contatos
|
groups | array of integer |
Matriz de IDs inteiros que se referem a grupos aos quais esse contato pertencerá. |
|
|
Marcas de contato
|
contact_tags | array of string |
Matriz de guids referentes a marcas anexadas a esse contato. |
|
|
ID do campo personalizado
|
id | string |
Guid referindo-se a um campo personalizado. |
|
|
Valor do campo personalizado
|
value | string |
O valor desse contato para este campo personalizado. |
|
|
Se a conversa atual com esse contato foi resolvida
|
is_resolved | boolean |
Determina se a conversa atual com esse contato foi resolvida. Todos os novos textos recebidos por esse contato definirão esse falso. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
phone_number
|
phone_number | string |
Número de telefone deste contato. |
|
first_name
|
first_name | string |
Nome deste contato. |
|
last_name
|
last_name | string |
Sobrenome desse contato. |
|
display_name
|
display_name | string |
Nome completo desse contato. Esse é o nome padrão exibido no aplicativo Web ao exibir contatos. |
|
is_suppressed
|
is_suppressed | boolean |
Se a conversa com esse contato é suprimida e, portanto, não enviada por push para a parte superior da fila de mensagens quando recebida. |
|
is_archived
|
is_archived | boolean |
Se a conversa com esse contato é arquivada e, portanto, não pode ser vista ao consultar conversas (por padrão). |
|
is_blocked
|
is_blocked | boolean |
Se a conversa com esse contato está bloqueada e, portanto, não é recebida ou armazenada. |
|
suppressed_reason
|
suppressed_reason | string |
Frase que descreve o motivo para suprimir o contato. Se is_suppressed for false, isso será nulo. |
|
nota
|
note | string |
Frase curta que descreve o contato. Usado para conveniência. Isso nunca é mostrado ao contato. |
|
groups
|
groups | array of integer |
Matriz de IDs de inteiros que se referem a grupos aos qual esse contato pertence. |
|
contact_tags
|
contact_tags | array of string |
Matriz de guids referentes a marcas anexadas a esse contato. |
|
custom_fields
|
custom_fields | array of object |
Matriz de IDs e valores de campo personalizados definidos para esse contato. |
|
id
|
custom_fields.id | string |
Guid referindo-se a um campo personalizado. |
|
value
|
custom_fields.value | string |
O valor desse contato para este campo personalizado. |
|
is_resolved
|
is_resolved | boolean |
Se a conversa com esse contato foi resolvida. Todos os novos textos recebidos por esse contato definirão esse falso. |
|
first_contact_utc
|
first_contact_utc | string |
Carimbo de data/hora de quando a primeira mensagem foi enviada para esse contato. |
|
opted_out_utc
|
opted_out_utc | string |
Carimbo de data/hora de quando esse contato optou por receber mensagens. |
|
last_msg_sent_utc
|
last_msg_sent_utc | string |
Carimbo de data/hora de quando a última mensagem foi enviada para esse contato. |
|
last_msg_received_utc
|
last_msg_received_utc | string |
Carimbo de data/hora de quando a última mensagem foi recebida desse contato. |
|
total_msgs_sent
|
total_msgs_sent | integer |
O número total de mensagens enviadas para esse contato. |
|
total_msgs_received
|
total_msgs_received | integer |
O número total de mensagens recebidas desse contato. |
|
response_count
|
response_count | integer |
Número total de mensagens de resposta do contato. |
|
date_created_utc
|
date_created_utc | string |
Carimbo de data/hora de quando o contato ths foi criado. |
|
last_contact_date_utc
|
last_contact_date_utc | string |
Carimbo de data/hora de quando a última mensagem foi enviada ou recebida desse contato. |
|
message_id
|
last_message.message_id | string |
ID da mensagem. Esse valor é exclusivo para cada mensagem. |
|
body
|
last_message.body | string |
Conteúdo desta mensagem. |
|
message_direction
|
last_message.message_direction | string |
Caractere singular, R ou S, indicando se essa mensagem foi recebida do contato ou enviada a eles, respectivamente. |
|
response_by_username
|
last_message.response_by_username | string |
Nome de usuário do usuário da Solicitação de Texto que enviou uma mensagem pela última vez a esse usuário. |
|
message_timestamp_utc
|
last_message.message_timestamp_utc | string |
Carimbo de data/hora de quando a mensagem foi enviada ou recebida pela Solicitação de Texto. |
|
delivery_status
|
last_message.delivery_status | string |
Status atual desta mensagem. Isso pode ser 'send', 'delivered', 'error' ou 'send'. |
|
delivery_error
|
last_message.delivery_error | string |
Erro que fez com que essa mensagem não fosse entregue. Se o delivery_status não for 'error', esse valor será nulo. |
|
mms_media
|
last_message.mms_media | array of string |
Lista de URLs que apontam para os anexos dessa mensagem. Todas as URLs serão urls geradas por solicitação de texto. |
Cria um novo grupo
Cria um novo grupo com o nome fornecido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
Nome do grupo
|
name | string |
O novo nome do grupo. |
|
|
Nota de grupo
|
notes | string |
Frase curta que descreve o grupo. Usado para conveniência. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
A ID numérica do grupo. |
|
group_member_count
|
group_member_count | integer |
O número de membros do grupo. |
|
is_keyword
|
is_keyword | boolean |
Esse grupo é um grupo de palavras-chave. Esses grupos são gerados automaticamente quando um usuário configura uma palavra-chave. Os contatos são adicionados automaticamente quando se registram. |
|
nome
|
name | string |
O nome desse grupo. |
|
notas
|
notes | string |
Todas as anotações sobre esse grupo. |
|
last_message_sent_utc
|
last_message_sent_utc | string |
Carimbo de data/hora de quando a última mensagem de grupo foi enviada para esse grupo. |
Cria um novo pagamento
Cria um novo pagamento com a mensagem fornecida para o contato fornecido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
Descrição do pagamento
|
description | string |
Descrição do pagamento. A descrição não é mostrada ao contato e é usada apenas por usuários internos para contexto sobre pagamentos. |
|
|
Número de telefone do destinatário
|
customer_phone | string |
O número de telefone do contato para o qual esse pagamento será enviado. |
|
|
Valor solicitado em dólares
|
amount_requested | float |
O valor em dólares solicitados por esse pagamento. |
|
|
Corpo do texto da mensagem de pagamento
|
message | string |
Texto da mensagem a ser enviado para contato junto com o link de pagamento. |
|
|
Cadeia de caracteres de referência do pagamento
|
reference_number | string |
ID definida pelo usuário definida quando são criados pagamentos que podem ser usados para localizar pagamentos rapidamente. Os números de referência não são exclusivos; muitos pagamentos podem ter a mesma referência. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
payment_id
|
payment_id | integer |
A ID numérica do pagamento. |
|
request_date
|
request_date | string |
O carimbo de data/hora de quando a mensagem inicial desse pagamento foi enfileirada para ser enviada. |
|
destinatário
|
recipient | string |
O nome do destinatário do pagamento. Isso poderá ser nulo se o contato não tiver um nome associado ao seu número de telefone. |
|
descrição
|
description | string |
A descrição do pagamento. Isso não é mostrado ao contato. Ele só é usado por usuários internos para contexto sobre pagamentos. |
|
customer_phone
|
customer_phone | string |
O número de telefone do contato que está sendo enviado para esse pagamento. |
|
amount_requested
|
amount_requested | float |
O valor em dólares solicitados por esse pagamento. |
|
is_past_due
|
is_past_due | boolean |
Se esse pagamento já passou da data da solicitação. |
|
reminder_was_sent
|
reminder_was_sent | boolean |
Se um lembrete de texto já foi enviado para esse pagamento. |
|
transaction_status
|
transaction_status | string |
O status da transação na authvia. Esse valor começa como Desconhecido. |
|
textrequest_payment_status
|
textrequest_payment_status | string |
O status da transação na Solicitação de Texto. Isso representa o status mostrado na página de pagamentos no aplicativo Solicitação de Texto. Ele começa como Enviado. |
|
reference_number
|
reference_number | string |
A ID definida pelo usuário definida quando são criados pagamentos que podem ser usados para localizar pagamentos rapidamente. Os números de referência não são exclusivos; muitos pagamentos podem ter a mesma referência. |
Criar ou atualizar um contato
Cria ou atualiza um contato (dependendo se já existe um com o número de telefone especificado).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
Número de telefone de contato
|
phone_number | True | string |
Número de telefone do contato a ser criado ou atualizado. |
|
Nome do contato
|
first_name | string |
O novo nome do contato. |
|
|
Sobrenome do contato
|
last_name | string |
O novo sobrenome do contato. |
|
|
Nome completo do contato
|
display_name | string |
O novo nome completo do contato. Esse é o nome padrão exibido no aplicativo Web ao exibir contatos. |
|
|
Se as mensagens desse contato são suprimidas
|
is_suppressed | boolean |
Determina se as conversas com esse contato são suprimidas e, portanto, não enviadas por push para a parte superior da fila de mensagens quando recebidas. |
|
|
Se as mensagens desse contato são arquivadas
|
is_archived | boolean |
Determina se as conversas com esse contato são arquivadas e, portanto, não podem ser vistas ao consultar conversas (por padrão). |
|
|
Se as mensagens desse contato estão bloqueadas
|
is_blocked | boolean |
Determina se as conversas com esse contato estão bloqueadas e, portanto, não são recebidas ou armazenadas. |
|
|
Motivo para suprimir esse contato
|
suppressed_reason | string |
Frase que descreve o motivo para suprimir o contato. |
|
|
Observação de contato
|
note | string |
Frase curta que descreve o contato. Usado para conveniência. Isso nunca é mostrado ao contato. |
|
|
Grupos de contatos
|
groups | array of integer |
Matriz de IDs inteiros que se referem a grupos aos quais esse contato pertencerá. |
|
|
Marcas de contato
|
contact_tags | array of string |
Matriz de guids referentes a marcas anexadas a esse contato. |
|
|
ID do campo personalizado
|
id | string |
Guid referindo-se a um campo personalizado. |
|
|
Valor do campo personalizado
|
value | string |
O valor desse contato para este campo personalizado. |
|
|
Se a conversa atual com esse contato foi resolvida
|
is_resolved | boolean |
Determina se a conversa atual com esse contato foi resolvida. Todos os novos textos recebidos por esse contato definirão esse falso. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
phone_number
|
phone_number | string |
Número de telefone deste contato. |
|
first_name
|
first_name | string |
Nome deste contato. |
|
last_name
|
last_name | string |
Sobrenome desse contato. |
|
display_name
|
display_name | string |
Nome completo desse contato. Esse é o nome padrão exibido no aplicativo Web ao exibir contatos. |
|
is_suppressed
|
is_suppressed | boolean |
Se a conversa com esse contato é suprimida e, portanto, não enviada por push para a parte superior da fila de mensagens quando recebida. |
|
is_archived
|
is_archived | boolean |
Se a conversa com esse contato é arquivada e, portanto, não pode ser vista ao consultar conversas (por padrão). |
|
is_blocked
|
is_blocked | boolean |
Se a conversa com esse contato está bloqueada e, portanto, não é recebida ou armazenada. |
|
suppressed_reason
|
suppressed_reason | string |
Frase que descreve o motivo para suprimir o contato. Se is_suppressed for false, isso será nulo. |
|
nota
|
note | string |
Frase curta que descreve o contato. Usado para conveniência. Isso nunca é mostrado ao contato. |
|
groups
|
groups | array of integer |
Matriz de IDs de inteiros que se referem a grupos aos qual esse contato pertence. |
|
contact_tags
|
contact_tags | array of string |
Matriz de guids referentes a marcas anexadas a esse contato. |
|
custom_fields
|
custom_fields | array of object |
Matriz de IDs e valores de campo personalizados definidos para esse contato. |
|
id
|
custom_fields.id | string |
Guid referindo-se a um campo personalizado. |
|
value
|
custom_fields.value | string |
O valor desse contato para este campo personalizado. |
|
is_resolved
|
is_resolved | boolean |
Se a conversa com esse contato foi resolvida. Todos os novos textos recebidos por esse contato definirão esse falso. |
|
first_contact_utc
|
first_contact_utc | string |
Carimbo de data/hora de quando a primeira mensagem foi enviada para esse contato. |
|
opted_out_utc
|
opted_out_utc | string |
Carimbo de data/hora de quando esse contato optou por receber mensagens. |
|
last_msg_sent_utc
|
last_msg_sent_utc | string |
Carimbo de data/hora de quando a última mensagem foi enviada para esse contato. |
|
last_msg_received_utc
|
last_msg_received_utc | string |
Carimbo de data/hora de quando a última mensagem foi recebida desse contato. |
|
total_msgs_sent
|
total_msgs_sent | integer |
O número total de mensagens enviadas para esse contato. |
|
total_msgs_received
|
total_msgs_received | integer |
O número total de mensagens recebidas desse contato. |
|
response_count
|
response_count | integer |
Número total de mensagens de resposta do contato. |
|
date_created_utc
|
date_created_utc | string |
Carimbo de data/hora de quando o contato ths foi criado. |
|
last_contact_date_utc
|
last_contact_date_utc | string |
Carimbo de data/hora de quando a última mensagem foi enviada ou recebida desse contato. |
|
message_id
|
last_message.message_id | string |
ID da mensagem. Esse valor é exclusivo para cada mensagem. |
|
body
|
last_message.body | string |
Conteúdo desta mensagem. |
|
message_direction
|
last_message.message_direction | string |
Caractere singular, R ou S, indicando se essa mensagem foi recebida do contato ou enviada a eles, respectivamente. |
|
response_by_username
|
last_message.response_by_username | string |
Nome de usuário do usuário da Solicitação de Texto que enviou uma mensagem pela última vez a esse usuário. |
|
message_timestamp_utc
|
last_message.message_timestamp_utc | string |
Carimbo de data/hora de quando a mensagem foi enviada ou recebida pela Solicitação de Texto. |
|
delivery_status
|
last_message.delivery_status | string |
Status atual desta mensagem. Isso pode ser 'send', 'delivered', 'error' ou 'send'. |
|
delivery_error
|
last_message.delivery_error | string |
Erro que fez com que essa mensagem não fosse entregue. Se o delivery_status não for 'error', esse valor será nulo. |
|
mms_media
|
last_message.mms_media | array of string |
Lista de URLs que apontam para os anexos dessa mensagem. Todas as URLs serão urls geradas por solicitação de texto. |
Criar um novo painel com o nome e o número de telefone fornecidos
Cria um novo painel na conta. Depois que o painel for criado, os administradores serão enviados por e-mail sobre a alteração e poderão começar a atribuir usuários. Esse ponto de extremidade pode fazer um painel para todos os números provisionados. Você pode pesquisar números provisionados em um código de área específico usando GET /dashboards/provisionamento. Se o número de telefone já estiver em uso, uma exceção de Solicitação Inválida será gerada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
nome
|
name | string |
O nome do painel. |
|
|
phone
|
phone | string |
O número de texto associado a este painel. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
A ID numérica do painel. |
|
nome
|
name | string |
O nome do painel. |
|
phone
|
phone | string |
O número de texto associado a este painel. |
Desarquivar uma conversa
Desarquiva uma conversa. Depois que uma conversa não for criada, ela será exibida novamente na fila. ele também será exibido em conversas retornadas pelo ponto de extremidade /conversations. Se uma conversa já não for pesquisada, esse método não terá efeito.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
Número de telefone da conversa
|
phone_number | True | string |
Número de telefone da conversa a ser arquivada. |
Retornos
- response
- string
Enviar um texto de acompanhamento lembrando o usuário de pagar o pagamento especificado
Envia um lembrete para o contato para pagar o pagamento especificado. O conteúdo da mensagem é gerado automaticamente. Para evitar spam, somente um lembrete pode ser enviado por pagamento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
ID do pagamento
|
payment_id | True | integer |
A ID numérica do pagamento a ser atualizado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
payment_id
|
payment_id | integer |
A ID numérica do pagamento. |
|
request_date
|
request_date | string |
O carimbo de data/hora de quando a mensagem inicial desse pagamento foi enfileirada para ser enviada. |
|
destinatário
|
recipient | string |
O nome do destinatário do pagamento. Isso poderá ser nulo se o contato não tiver um nome associado ao seu número de telefone. |
|
descrição
|
description | string |
A descrição do pagamento. Isso não é mostrado ao contato. Ele só é usado por usuários internos para contexto sobre pagamentos. |
|
customer_phone
|
customer_phone | string |
O número de telefone do contato que está sendo enviado para esse pagamento. |
|
amount_requested
|
amount_requested | float |
O valor em dólares solicitados por esse pagamento. |
|
is_past_due
|
is_past_due | boolean |
Se esse pagamento já passou da data da solicitação. |
|
reminder_was_sent
|
reminder_was_sent | boolean |
Se um lembrete de texto já foi enviado para esse pagamento. |
|
transaction_status
|
transaction_status | string |
O status da transação na authvia. Esse valor começa como Desconhecido. |
|
textrequest_payment_status
|
textrequest_payment_status | string |
O status da transação na Solicitação de Texto. Isso representa o status mostrado na página de pagamentos no aplicativo Solicitação de Texto. Ele começa como Enviado. |
|
reference_number
|
reference_number | string |
A ID definida pelo usuário definida quando são criados pagamentos que podem ser usados para localizar pagamentos rapidamente. Os números de referência não são exclusivos; muitos pagamentos podem ter a mesma referência. |
Enviar uma mensagem para o contato com o número de telefone especificado
Envia uma mensagem (iniciando uma nova conversa se o número de telefone especificado não tiver histórico de mensagens).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
Número de Telefone para Mensagem
|
phone_number | True | string |
Número de telefone do contato para o qual enviar uma mensagem. |
|
Corpo da mensagem
|
body | string |
Conteúdo da mensagem a ser enviada. |
|
|
Nome do remetente
|
sender_name | string |
O nome do remetente da mensagem. Isso é mostrado no aplicativo Web TextRequest e na api ao recuperar essa mensagem. |
|
|
URL de retorno de chamada para quando o status da mensagem for atualizado
|
status_callback | string |
Url do aplicativo Web a ser atingida com um comando POST sempre que o status dessa mensagem passa de não entregue para enviado (ou erro). |
|
|
URL de retorno de chamada para solicitações de localização se essa mensagem incluir uma
|
location_callback | string |
Url de retorno de chamada de localização a ser atingida com um comando POST quando o usuário acessa e aprova o compartilhamento de sua localização com o remetente. Para incluir o link, adicione [Solicitação de Localização] ao corpo da mensagem. Esse retorno de chamada não é necessário para solicitações de localização, mas pode ser útil para APIs. |
|
|
Anexos de mídia MMS para esta mensagem
|
mms_media | array of string |
Matriz de anexos de mídia MMS para esta mensagem. Os anexos devem ser urls obtidos do ponto de extremidade pós/mms (não incluídos neste conector). Links de anexo externo não serão aceitos. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
message_id
|
message_id | string |
ID da mensagem. Esse valor é exclusivo para cada mensagem. |
|
body
|
body | string |
Conteúdo desta mensagem. |
|
message_direction
|
message_direction | string |
Caractere singular, R ou S, indicando se essa mensagem foi recebida do contato ou enviada a eles, respectivamente. |
|
response_by_username
|
response_by_username | string |
Nome de usuário do usuário da Solicitação de Texto que enviou uma mensagem pela última vez a esse usuário. |
|
message_timestamp_utc
|
message_timestamp_utc | string |
Carimbo de data/hora de quando a mensagem foi enviada ou recebida pela Solicitação de Texto. |
|
delivery_status
|
delivery_status | string |
Status atual desta mensagem. Isso pode ser 'send', 'delivered', 'error' ou 'send'. |
|
delivery_error
|
delivery_error | string |
Erro que fez com que essa mensagem não fosse entregue. Se o delivery_status não for 'error', esse valor será nulo. |
|
mms_media
|
mms_media | array of string |
Lista de URLs que apontam para os anexos dessa mensagem. Todas as URLs serão urls geradas por solicitação de texto. |
Exclui o contato com o número de telefone especificado
Exclui o contato com o número de telefone especificado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
Número de telefone de contato
|
phone_number | True | string |
Número de telefone do contato a ser excluído. |
Retornos
- response
- string
Exclui o grupo com a ID especificada
Exclui o grupo com a ID especificada. Isso terá êxito mesmo se houver contatos que sejam membros do grupo (os contatos não serão excluídos).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
ID do grupo
|
group_id | True | integer |
A ID numérica do grupo a ser excluído. |
Retornos
- response
- string
Exclui o painel especificado
Exclui o painel especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
Retornos
- response
- string
Marcar um pagamento como pago
Fecha um pagamento como "pago". Use esse ponto de extremidade para quando o pagamento for pago por meio de um meio diferente do portal de solicitação de pagamento. Isso fechará o pagamento e adicionará seu valor de pagamento às suas estatísticas. Esse ponto de extremidade não é necessário para pagamentos pagos por meio do portal de pagamentos enviado por meio da Solicitação de Texto; que marcará automaticamente um pagamento conforme pago.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
ID do pagamento
|
payment_id | True | integer |
A ID numérica do pagamento a ser atualizado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
payment_id
|
payment_id | integer |
A ID numérica do pagamento. |
|
request_date
|
request_date | string |
O carimbo de data/hora de quando a mensagem inicial desse pagamento foi enfileirada para ser enviada. |
|
destinatário
|
recipient | string |
O nome do destinatário do pagamento. Isso poderá ser nulo se o contato não tiver um nome associado ao seu número de telefone. |
|
descrição
|
description | string |
A descrição do pagamento. Isso não é mostrado ao contato. Ele só é usado por usuários internos para contexto sobre pagamentos. |
|
customer_phone
|
customer_phone | string |
O número de telefone do contato que está sendo enviado para esse pagamento. |
|
amount_requested
|
amount_requested | float |
O valor em dólares solicitados por esse pagamento. |
|
is_past_due
|
is_past_due | boolean |
Se esse pagamento já passou da data da solicitação. |
|
reminder_was_sent
|
reminder_was_sent | boolean |
Se um lembrete de texto já foi enviado para esse pagamento. |
|
transaction_status
|
transaction_status | string |
O status da transação na authvia. Esse valor começa como Desconhecido. |
|
textrequest_payment_status
|
textrequest_payment_status | string |
O status da transação na Solicitação de Texto. Isso representa o status mostrado na página de pagamentos no aplicativo Solicitação de Texto. Ele começa como Enviado. |
|
reference_number
|
reference_number | string |
A ID definida pelo usuário definida quando são criados pagamentos que podem ser usados para localizar pagamentos rapidamente. Os números de referência não são exclusivos; muitos pagamentos podem ter a mesma referência. |
Obter informações neste painel específico
Retorna o nome e o telefone do painel.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
A ID numérica do painel. |
|
nome
|
name | string |
O nome do painel. |
|
phone
|
phone | string |
O número de texto associado a este painel. |
Obter mensagens de uma conversa pelo número de telefone de um contato
Obtenha a conversa entre o painel especificado e o número de telefone.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página número a ser obtido
|
page | True | integer |
A página de entidades a serem obtidos. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última página, uma matriz vazia será retornada. |
|
Quantidade de cada entidade a ser obtido por página
|
page_size | True | integer |
O tamanho de cada página a ser obtido. Ao obter valores, esse é um tamanho máximo por página, com o acesso às páginas subsequentes feitas pelo parâmetro de página. |
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
Número de telefone do contato pelo qual pesquisar
|
phone_number | True | string |
Número de telefone do contato para o qual obter mensagens. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
meta.page | integer |
A página de entidades obtida. A quantidade de entidades nesta página é definida por page_size. |
|
page_size
|
meta.page_size | integer |
O número de entidades obtidas nesta página. |
|
total_items
|
meta.total_items | integer |
O número de entidades disponíveis no banco de dados, independentemente do tamanho ou número da página. Para ver as outras páginas, altere o número da página na solicitação. |
|
items
|
items | array of object |
Lista de entidades de mensagem obtidas da Solicitação de Texto. |
|
message_id
|
items.message_id | string |
ID da mensagem. Esse valor é exclusivo para cada mensagem. |
|
body
|
items.body | string |
Conteúdo desta mensagem. |
|
message_direction
|
items.message_direction | string |
Caractere singular, R ou S, indicando se essa mensagem foi recebida do contato ou enviada a eles, respectivamente. |
|
response_by_username
|
items.response_by_username | string |
Nome de usuário do usuário da Solicitação de Texto que enviou uma mensagem pela última vez a esse usuário. |
|
message_timestamp_utc
|
items.message_timestamp_utc | string |
Carimbo de data/hora de quando a mensagem foi enviada ou recebida pela Solicitação de Texto. |
|
delivery_status
|
items.delivery_status | string |
Status atual desta mensagem. Isso pode ser 'send', 'delivered', 'error' ou 'send'. |
|
delivery_error
|
items.delivery_error | string |
Erro que fez com que essa mensagem não fosse entregue. Se o delivery_status não for 'error', esse valor será nulo. |
|
mms_media
|
items.mms_media | array of string |
Lista de URLs que apontam para os anexos dessa mensagem. Todas as URLs serão urls geradas por solicitação de texto. |
Obter todos os contatos que correspondem ao critério de filtragem especificado
Obtém todos os contatos que correspondem ao critério de filtragem especificado. Somente o painel especificado será pesquisado; não há nenhuma pesquisa no nível da conta para um número disponível.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número de telefone do contato pelo qual pesquisar
|
contact_phone_number | string |
Número de telefone pelo qual filtrar contatos. |
|
|
Carimbo de data/hora de pesquisa 'Hora da última mensagem enviada antes' no horário UTC
|
last_message_timestamp_before_utc | date-time |
Tempo de corte para pesquisar contatos pela última mensagem enviada ou recebida. Nenhum contato que enviou mensagens após esse horário será mostrado. |
|
|
Carimbo de data/hora de pesquisa 'Hora da última mensagem enviada após' no horário UTC
|
last_message_timestamp_after_utc | date-time |
Tempo de corte para pesquisar contatos pela última mensagem enviada ou recebida. Nenhum contato cuja última mensagem enviada é antes dessa hora será exibida. |
|
|
Carimbo de data/hora de pesquisa 'Criado antes'
|
contact_created_before | date-time |
Tempo de corte para pesquisar contatos quando eles foram criados. Nenhum contato criado após esse horário será mostrado. |
|
|
Carimbo de data/hora de pesquisa 'Criado após'
|
contact_created_after | date-time |
Tempo de corte para pesquisar contatos quando eles foram criados. Nenhum contato criado antes dessa hora será mostrado. |
|
|
Se a conversa do contato foi resolvida
|
is_resolved | boolean |
Se deve procurar contatos cujas conversas foram resolvidas. |
|
|
Se o contato está bloqueado
|
is_blocked | boolean |
Se deve procurar contatos que foram bloqueados. |
|
|
Se o contato está arquivado
|
is_archived | boolean |
Se deve procurar contatos que foram arquivados. |
|
|
Se o contato é suprimido
|
is_suppressed | boolean |
Se deve procurar contatos que foram suprimidos. |
|
|
Se o contato optou por sair
|
has_opted_out | boolean |
Se deseja procurar contatos que recusaram o recebimento de textos. |
|
|
Carimbo de data/hora de pesquisa 'Hora da última mensagem enviada antes'
|
last_message_sent_before | date-time |
Tempo de corte para pesquisar contatos quando a última mensagem foi enviada ao cliente. Nenhum contato que enviou mensagens após esse horário será mostrado. Usa o carimbo de data/hora como hora local. Para filtrar por carimbo de data/hora no horário UTC, use last_message_sent_before_utc |
|
|
Carimbo de data/hora de pesquisa 'Hora da última mensagem enviada após'
|
last_message_sent_after | date-time |
Tempo de corte para pesquisar contatos quando a última mensagem foi enviada ao cliente. Nenhum contato cuja última mensagem enviada é antes dessa hora será exibida. Usa o carimbo de data/hora como hora local. Para filtrar por carimbo de data/hora no horário UTC, use last_message_sent_after_utc |
|
|
Carimbo de data/hora da pesquisa 'Hora da última mensagem recebida antes'
|
last_message_received_before | date-time |
Tempo de corte para pesquisar contatos pela última mensagem recebida do cliente. Nenhum contato que recebeu mensagens após esse horário será mostrado. Usa o carimbo de data/hora como hora local. Para filtrar por carimbo de data/hora no horário UTC, use last_message_sent_before_utc |
|
|
Carimbo de data/hora da pesquisa 'Hora da última mensagem recebida após'
|
last_message_received_after | date-time |
Tempo de corte para pesquisar contatos pela última mensagem recebida do cliente. Nenhum contato cuja última mensagem enviada é antes dessa hora será exibida. Usa o carimbo de data/hora como hora local. Para filtrar por carimbo de data/hora no horário UTC, use last_message_sent_before_utc |
|
|
Marcas de contato
|
tags | string |
Lista separada por vírgulas de guids que se referem a marcas para filtrar contatos. |
|
|
Grupos de contatos
|
groups | string |
Lista separada por vírgulas de IDs de inteiros que se referem a grupos para filtrar contatos. |
|
|
ID do campo personalizado a ser filtrado por
|
custom_field_id_1 | string |
Guid referindo-se ao campo personalizado pelo qual filtrar contatos. |
|
|
Valor do campo personalizado a ser filtrado por
|
custom_field_value_1 | string |
Valor referente ao campo personalizado pelo qual filtrar contatos. |
|
|
ID do segundo campo personalizado a ser filtrado por
|
custom_field_id_2 | string |
Guid referindo-se ao segundo campo personalizado pelo qual filtrar contatos. |
|
|
Valor do segundo campo personalizado a ser filtrado por
|
custom_field_value_2 | string |
Valor referente ao segundo campo personalizado pelo qual filtrar contatos. |
|
|
ID do terceiro campo personalizado a ser filtrado por
|
custom_field_id_3 | string |
Guid referindo-se ao terceiro campo personalizado pelo qual filtrar contatos. |
|
|
Valor do terceiro campo personalizado a ser filtrado por
|
custom_field_value_3 | string |
Valor referente ao terceiro campo personalizado pelo qual filtrar contatos. |
|
|
Página número a ser obtido
|
page | True | integer |
A página de entidades a serem obtidos. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última página, uma matriz vazia será retornada. |
|
Quantidade de cada entidade a ser obtido por página
|
page_size | True | integer |
O tamanho de cada página a ser obtido. Ao obter valores, esse é um tamanho máximo por página, com o acesso às páginas subsequentes feitas pelo parâmetro de página. |
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
meta.page | integer |
A página de entidades obtida. A quantidade de entidades nesta página é definida por page_size. |
|
page_size
|
meta.page_size | integer |
O número de entidades obtidas nesta página. |
|
total_items
|
meta.total_items | integer |
O número de entidades disponíveis no banco de dados, independentemente do tamanho ou número da página. Para ver as outras páginas, altere o número da página na solicitação. |
|
items
|
items | array of object |
Lista de entidades de contato obtidas da Solicitação de Texto. |
|
phone_number
|
items.phone_number | string |
Número de telefone deste contato. |
|
first_name
|
items.first_name | string |
Nome deste contato. |
|
last_name
|
items.last_name | string |
Sobrenome desse contato. |
|
display_name
|
items.display_name | string |
Nome completo desse contato. Esse é o nome padrão exibido no aplicativo Web ao exibir contatos. |
|
is_suppressed
|
items.is_suppressed | boolean |
Se a conversa com esse contato é suprimida e, portanto, não enviada por push para a parte superior da fila de mensagens quando recebida. |
|
is_archived
|
items.is_archived | boolean |
Se a conversa com esse contato é arquivada e, portanto, não pode ser vista ao consultar conversas (por padrão). |
|
is_blocked
|
items.is_blocked | boolean |
Se a conversa com esse contato está bloqueada e, portanto, não é recebida ou armazenada. |
|
suppressed_reason
|
items.suppressed_reason | string |
Frase que descreve o motivo para suprimir o contato. Se is_suppressed for false, isso será nulo. |
|
nota
|
items.note | string |
Frase curta que descreve o contato. Usado para conveniência. Isso nunca é mostrado ao contato. |
|
groups
|
items.groups | array of integer |
Matriz de IDs de inteiros que se referem a grupos aos qual esse contato pertence. |
|
contact_tags
|
items.contact_tags | array of string |
Matriz de guids referentes a marcas anexadas a esse contato. |
|
custom_fields
|
items.custom_fields | array of object |
Matriz de IDs e valores de campo personalizados definidos para esse contato. |
|
id
|
items.custom_fields.id | string |
Guid referindo-se a um campo personalizado. |
|
value
|
items.custom_fields.value | string |
O valor desse contato para este campo personalizado. |
|
is_resolved
|
items.is_resolved | boolean |
Se a conversa com esse contato foi resolvida. Todos os novos textos recebidos por esse contato definirão esse falso. |
|
first_contact_utc
|
items.first_contact_utc | string |
Carimbo de data/hora de quando a primeira mensagem foi enviada para esse contato. |
|
opted_out_utc
|
items.opted_out_utc | string |
Carimbo de data/hora de quando esse contato optou por receber mensagens. |
|
last_msg_sent_utc
|
items.last_msg_sent_utc | string |
Carimbo de data/hora de quando a última mensagem foi enviada para esse contato. |
|
last_msg_received_utc
|
items.last_msg_received_utc | string |
Carimbo de data/hora de quando a última mensagem foi recebida desse contato. |
|
total_msgs_sent
|
items.total_msgs_sent | integer |
O número total de mensagens enviadas para esse contato. |
|
total_msgs_received
|
items.total_msgs_received | integer |
O número total de mensagens recebidas desse contato. |
|
response_count
|
items.response_count | integer |
Número total de mensagens de resposta do contato. |
|
date_created_utc
|
items.date_created_utc | string |
Carimbo de data/hora de quando o contato ths foi criado. |
|
last_contact_date_utc
|
items.last_contact_date_utc | string |
Carimbo de data/hora de quando a última mensagem foi enviada ou recebida desse contato. |
|
message_id
|
items.last_message.message_id | string |
ID da mensagem. Esse valor é exclusivo para cada mensagem. |
|
body
|
items.last_message.body | string |
Conteúdo desta mensagem. |
|
message_direction
|
items.last_message.message_direction | string |
Caractere singular, R ou S, indicando se essa mensagem foi recebida do contato ou enviada a eles, respectivamente. |
|
response_by_username
|
items.last_message.response_by_username | string |
Nome de usuário do usuário da Solicitação de Texto que enviou uma mensagem pela última vez a esse usuário. |
|
message_timestamp_utc
|
items.last_message.message_timestamp_utc | string |
Carimbo de data/hora de quando a mensagem foi enviada ou recebida pela Solicitação de Texto. |
|
delivery_status
|
items.last_message.delivery_status | string |
Status atual desta mensagem. Isso pode ser 'send', 'delivered', 'error' ou 'send'. |
|
delivery_error
|
items.last_message.delivery_error | string |
Erro que fez com que essa mensagem não fosse entregue. Se o delivery_status não for 'error', esse valor será nulo. |
|
mms_media
|
items.last_message.mms_media | array of string |
Lista de URLs que apontam para os anexos dessa mensagem. Todas as URLs serão urls geradas por solicitação de texto. |
Obter todos os dashboards em uma conta
Obtém todos os dashboards em uma conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página número a ser obtido
|
page | integer |
A página de entidades a serem obtidos. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última página, uma matriz vazia será retornada. |
|
|
Quantidade de cada entidade a ser obtido por página
|
page_size | integer |
O tamanho de cada página a ser obtido. Ao obter valores, esse é um tamanho máximo por página, com o acesso às páginas subsequentes feitas pelo parâmetro de página. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
meta.page | integer |
A página de entidades obtida. A quantidade de entidades nesta página é definida por page_size. |
|
page_size
|
meta.page_size | integer |
O número de entidades obtidas nesta página. |
|
total_items
|
meta.total_items | integer |
O número de entidades disponíveis no banco de dados, independentemente do tamanho ou número da página. Para ver as outras páginas, altere o número da página na solicitação. |
|
items
|
items | array of object |
Lista de entidades de painel obtidas da Solicitação de Texto. |
|
id
|
items.id | integer |
A ID numérica do painel. |
|
nome
|
items.name | string |
O nome do painel. |
|
phone
|
items.phone | string |
O número de texto associado a este painel. |
Obter um grupo por sua ID
Obtém o grupo com a ID especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
ID do grupo
|
group_id | True | integer |
A ID numérica do grupo a ser obtido. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer |
A ID numérica do grupo. |
|
group_member_count
|
group_member_count | integer |
O número de membros do grupo. |
|
is_keyword
|
is_keyword | boolean |
Esse grupo é um grupo de palavras-chave. Esses grupos são gerados automaticamente quando um usuário configura uma palavra-chave. Os contatos são adicionados automaticamente quando se registram. |
|
nome
|
name | string |
O nome desse grupo. |
|
notas
|
notes | string |
Todas as anotações sobre esse grupo. |
|
last_message_sent_utc
|
last_message_sent_utc | string |
Carimbo de data/hora de quando a última mensagem de grupo foi enviada para esse grupo. |
Obtém o contato com o número de telefone especificado
Obtém o contato com o número de telefone especificado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
Número de telefone do contato
|
phone_number | True | string |
Número de telefone do contato a ser obtido. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
phone_number
|
phone_number | string |
Número de telefone deste contato. |
|
first_name
|
first_name | string |
Nome deste contato. |
|
last_name
|
last_name | string |
Sobrenome desse contato. |
|
display_name
|
display_name | string |
Nome completo desse contato. Esse é o nome padrão exibido no aplicativo Web ao exibir contatos. |
|
is_suppressed
|
is_suppressed | boolean |
Se a conversa com esse contato é suprimida e, portanto, não enviada por push para a parte superior da fila de mensagens quando recebida. |
|
is_archived
|
is_archived | boolean |
Se a conversa com esse contato é arquivada e, portanto, não pode ser vista ao consultar conversas (por padrão). |
|
is_blocked
|
is_blocked | boolean |
Se a conversa com esse contato está bloqueada e, portanto, não é recebida ou armazenada. |
|
suppressed_reason
|
suppressed_reason | string |
Frase que descreve o motivo para suprimir o contato. Se is_suppressed for false, isso será nulo. |
|
nota
|
note | string |
Frase curta que descreve o contato. Usado para conveniência. Isso nunca é mostrado ao contato. |
|
groups
|
groups | array of integer |
Matriz de IDs de inteiros que se referem a grupos aos qual esse contato pertence. |
|
contact_tags
|
contact_tags | array of string |
Matriz de guids referentes a marcas anexadas a esse contato. |
|
custom_fields
|
custom_fields | array of object |
Matriz de IDs e valores de campo personalizados definidos para esse contato. |
|
id
|
custom_fields.id | string |
Guid referindo-se a um campo personalizado. |
|
value
|
custom_fields.value | string |
O valor desse contato para este campo personalizado. |
|
is_resolved
|
is_resolved | boolean |
Se a conversa com esse contato foi resolvida. Todos os novos textos recebidos por esse contato definirão esse falso. |
|
first_contact_utc
|
first_contact_utc | string |
Carimbo de data/hora de quando a primeira mensagem foi enviada para esse contato. |
|
opted_out_utc
|
opted_out_utc | string |
Carimbo de data/hora de quando esse contato optou por receber mensagens. |
|
last_msg_sent_utc
|
last_msg_sent_utc | string |
Carimbo de data/hora de quando a última mensagem foi enviada para esse contato. |
|
last_msg_received_utc
|
last_msg_received_utc | string |
Carimbo de data/hora de quando a última mensagem foi recebida desse contato. |
|
total_msgs_sent
|
total_msgs_sent | integer |
O número total de mensagens enviadas para esse contato. |
|
total_msgs_received
|
total_msgs_received | integer |
O número total de mensagens recebidas desse contato. |
|
response_count
|
response_count | integer |
O número total de mensagens de resposta do contato. |
|
date_created_utc
|
date_created_utc | string |
O carimbo de data/hora de quando o contato ths foi criado. |
|
last_contact_date_utc
|
last_contact_date_utc | string |
O carimbo de data/hora de quando a última mensagem foi enviada ou recebida desse contato. |
|
message_id
|
last_message.message_id | string |
ID da mensagem. Esse valor é exclusivo para cada mensagem. |
|
body
|
last_message.body | string |
Conteúdo desta mensagem. |
|
message_direction
|
last_message.message_direction | string |
Caractere singular, R ou S, indicando se essa mensagem foi recebida do contato ou enviada a eles, respectivamente. |
|
response_by_username
|
last_message.response_by_username | string |
Nome de usuário do usuário da Solicitação de Texto que enviou uma mensagem pela última vez a esse usuário. |
|
message_timestamp_utc
|
last_message.message_timestamp_utc | string |
Carimbo de data/hora de quando a mensagem foi enviada ou recebida pela Solicitação de Texto. |
|
delivery_status
|
last_message.delivery_status | string |
Status atual desta mensagem. Isso pode ser 'send', 'delivered', 'error' ou 'send'. |
|
delivery_error
|
last_message.delivery_error | string |
Erro que fez com que essa mensagem não fosse entregue. Se o delivery_status não for 'error', esse valor será nulo. |
|
mms_media
|
last_message.mms_media | array of string |
Lista de URLs que apontam para os anexos dessa mensagem. Todas as URLs serão urls geradas por solicitação de texto. |
Obtém o pagamento com a ID especificada
Obtém o pagamento com a ID especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
ID do pagamento
|
payment_id | True | integer |
A ID numérica do pagamento a ser obtido. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
payment_id
|
payment_id | integer |
A ID numérica do pagamento. |
|
request_date
|
request_date | string |
O carimbo de data/hora de quando a mensagem inicial desse pagamento foi enfileirada para ser enviada. |
|
destinatário
|
recipient | string |
O nome do destinatário do pagamento. Isso poderá ser nulo se o contato não tiver um nome associado ao seu número de telefone. |
|
descrição
|
description | string |
A descrição do pagamento. Isso não é mostrado ao contato. Ele só é usado por usuários internos para contexto sobre pagamentos. |
|
customer_phone
|
customer_phone | string |
O número de telefone do contato que está sendo enviado para esse pagamento. |
|
amount_requested
|
amount_requested | float |
O valor em dólares solicitados por esse pagamento. |
|
is_past_due
|
is_past_due | boolean |
Se esse pagamento já passou da data da solicitação. |
|
reminder_was_sent
|
reminder_was_sent | boolean |
Se um lembrete de texto já foi enviado para esse pagamento. |
|
transaction_status
|
transaction_status | string |
O status da transação na authvia. Esse valor começa como Desconhecido. |
|
textrequest_payment_status
|
textrequest_payment_status | string |
O status da transação na Solicitação de Texto. Isso representa o status mostrado na página de pagamentos no aplicativo Solicitação de Texto. Ele começa como Enviado. |
|
reference_number
|
reference_number | string |
A ID definida pelo usuário definida quando são criados pagamentos que podem ser usados para localizar pagamentos rapidamente. Os números de referência não são exclusivos; muitos pagamentos podem ter a mesma referência. |
Obtém todas as conversas para este painel
Obtém todas as conversas para este painel e inclui informações sobre a última mensagem para cada conversa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Marcas de contato
|
tags | string |
Lista separada por vírgulas de guids que se referem a marcas para filtrar conversas. |
|
|
Se deve mostrar apenas conversas resolvidas
|
show_unresolved_only | string |
Se deve apenas procurar contatos cujas conversas foram resolvidas. Se isso for falso, conversas resolvidas e não resolvidas serão mostradas. |
|
|
Se deve incluir conversas arquivadas
|
include_archived | string |
Se deve incluir conversas com contatos que foram arquivados. |
|
|
Termo a ser filtrado para números de telefone e nome de contato
|
search | string |
Termo de pesquisa para filtrar conversas por número de telefone ou nome de exibição. Se o termo de pesquisa for menor que um nome completo ou um número de telefone, a pesquisa retornará todas as conversas que correspondem parcialmente a ela. |
|
|
Página número a ser obtido
|
page | integer |
A página de entidades a serem obtidos. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última página, uma matriz vazia será retornada. |
|
|
Quantidade de cada entidade a ser obtido por página
|
page_size | integer |
O tamanho de cada página a ser obtido. Ao obter valores, esse é um tamanho máximo por página, com o acesso às páginas subsequentes feitas pelo parâmetro de página. |
|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
meta.page | integer |
A página de entidades obtida. A quantidade de entidades nesta página é definida por page_size. |
|
page_size
|
meta.page_size | integer |
O número de entidades obtidas nesta página. |
|
total_items
|
meta.total_items | integer |
O número de entidades disponíveis no banco de dados, independentemente do tamanho ou número da página. Para ver as outras páginas, altere o número da página na solicitação. |
|
items
|
items | array of object |
Lista de entidades de conversa obtidas da Solicitação de Texto. |
|
phone_number
|
items.phone_number | string |
O número de telefone do contato. |
|
message_id
|
items.last_message.message_id | string |
ID da mensagem. Esse valor é exclusivo para cada mensagem. |
|
body
|
items.last_message.body | string |
Conteúdo desta mensagem. |
|
message_direction
|
items.last_message.message_direction | string |
Caractere singular, R ou S, indicando se essa mensagem foi recebida do contato ou enviada a eles, respectivamente. |
|
response_by_username
|
items.last_message.response_by_username | string |
Nome de usuário do usuário da Solicitação de Texto que enviou uma mensagem pela última vez a esse usuário. |
|
message_timestamp_utc
|
items.last_message.message_timestamp_utc | string |
Carimbo de data/hora de quando a mensagem foi enviada ou recebida pela Solicitação de Texto. |
|
delivery_status
|
items.last_message.delivery_status | string |
Status atual desta mensagem. Isso pode ser 'send', 'delivered', 'error' ou 'send'. |
|
delivery_error
|
items.last_message.delivery_error | string |
Erro que fez com que essa mensagem não fosse entregue. Se o delivery_status não for 'error', esse valor será nulo. |
|
mms_media
|
items.last_message.mms_media | array of string |
Lista de URLs que apontam para os anexos dessa mensagem. Todas as URLs serão urls geradas por solicitação de texto. |
Obtém todas as marcas
Obtém todas as marcas deste painel. As marcas são exclusivas entre dashboards.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
|
Página número a ser obtido
|
page | True | integer |
A página de entidades a serem obtidos. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última página, uma matriz vazia será retornada. |
|
Quantidade de cada entidade a ser obtido por página
|
page_size | True | integer |
O tamanho de cada página a ser obtido. Ao obter valores, esse é um tamanho máximo por página, com o acesso às páginas subsequentes feitas pelo parâmetro de página. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
meta.page | integer |
A página de entidades obtida. A quantidade de entidades nesta página é definida por page_size. |
|
page_size
|
meta.page_size | integer |
O número de entidades obtidas nesta página. |
|
total_items
|
meta.total_items | integer |
O número de entidades disponíveis no banco de dados, independentemente do tamanho ou número da página. Para ver as outras páginas, altere o número da página na solicitação. |
|
items
|
items | array of object |
Lista de entidades de marca obtidas da Solicitação de Texto. |
|
id
|
items.id | string |
A ID numérica da marca. |
|
tag_color
|
items.tag_color | string |
A cor da marca. Esse deve ser um código de cor hexadecimal válido. |
|
marca
|
items.tag | string |
O nome da marca. |
Obtém todos os campos personalizados
Obtém todos os campos personalizados para este painel. Os campos personalizados são exclusivos entre dashboards.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
A ID numérica do campo. |
|
nome
|
name | string |
O nome do campo personalizado. |
Obtém todos os grupos
Obtém todos os grupos para a conta do usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página número a ser obtido
|
page | True | integer |
A página de entidades a serem obtidos. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última página, uma matriz vazia será retornada. |
|
Quantidade de cada entidade a ser obtido por página
|
page_size | True | integer |
O tamanho de cada página a ser obtido. Ao obter valores, esse é um tamanho máximo por página, com o acesso às páginas subsequentes feitas pelo parâmetro de página. |
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
meta.page | integer |
A página de entidades obtida. A quantidade de entidades nesta página é definida por page_size. |
|
page_size
|
meta.page_size | integer |
O número de entidades obtidas nesta página. |
|
total_items
|
meta.total_items | integer |
O número de entidades disponíveis no banco de dados, independentemente do tamanho ou número da página. Para ver as outras páginas, altere o número da página na solicitação. |
|
items
|
items | array of object |
Lista de entidades de grupo obtidas da Solicitação de Texto. |
|
id
|
items.id | integer |
A ID numérica do grupo. |
|
group_member_count
|
items.group_member_count | integer |
O número de membros do grupo. |
|
is_keyword
|
items.is_keyword | boolean |
Esse grupo é um grupo de palavras-chave. Esses grupos são gerados automaticamente quando um usuário configura uma palavra-chave. Os contatos são adicionados automaticamente quando se registram. |
|
nome
|
items.name | string |
O nome desse grupo. |
|
notas
|
items.notes | string |
Todas as anotações sobre esse grupo. |
|
last_message_sent_utc
|
items.last_message_sent_utc | string |
O carimbo de data/hora de quando a última mensagem de grupo foi enviada para esse grupo. |
Obtém todos os pagamentos
Obtém todos os pagamentos, incluindo pagamentos cancelados e pagos. Elas podem ser filtradas usando os parâmetros de consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Cadeia de caracteres de referência do pagamento
|
reference_number | string |
ID definida pelo usuário definida quando são criados pagamentos que podem ser usados para localizar pagamentos rapidamente. Os números de referência não são exclusivos; muitos pagamentos podem ter a mesma referência. |
|
|
Número de telefone de pagamento
|
phone_number | string |
Número de telefone do contato para o qual esse pagamento foi enviado. |
|
|
Classificação por
|
sort_type | string |
Propriedade para classificar pagamentos por. Pode ser "quantidade", "contato", "data", "status". |
|
|
Direção de classificação
|
sort_direction | string |
Direção para classificar pagamentos. Pode ser "desc" para maior a menor, ou "asc" para o menor a maior. |
|
|
Página número a ser obtido
|
page | True | integer |
A página de entidades a serem obtidos. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última página, uma matriz vazia será retornada. |
|
Quantidade de cada entidade a ser obtido por página
|
page_size | True | integer |
O tamanho de cada página a ser obtido. Ao obter valores, esse é um tamanho máximo por página, com o acesso às páginas subsequentes feitas pelo parâmetro de página. |
|
ID do painel para fazer essa chamada em
|
dashboard_id | True | integer |
O painel de números de telefone no qual trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
página
|
meta.page | integer |
A página de entidades obtida. A quantidade de entidades nesta página é definida por page_size. |
|
page_size
|
meta.page_size | integer |
O número de entidades obtidas nesta página. |
|
total_items
|
meta.total_items | integer |
O número de entidades disponíveis no banco de dados, independentemente do tamanho ou número da página. Para ver as outras páginas, altere o número da página na solicitação. |
|
items
|
items | array of object |
Lista de entidades de pagamento obtidas da Solicitação de Texto. |
|
payment_id
|
items.payment_id | integer |
A ID numérica do pagamento. |
|
request_date
|
items.request_date | string |
O carimbo de data/hora de quando a mensagem inicial desse pagamento foi enfileirada para ser enviada. |
|
destinatário
|
items.recipient | string |
O nome do destinatário do pagamento. Isso poderá ser nulo se o contato não tiver um nome associado ao seu número de telefone. |
|
descrição
|
items.description | string |
A descrição do pagamento. Isso não é mostrado ao contato. Ele só é usado por usuários internos para contexto sobre pagamentos. |
|
customer_phone
|
items.customer_phone | string |
O número de telefone do contato que está sendo enviado para esse pagamento. |
|
amount_requested
|
items.amount_requested | float |
O valor em dólares solicitados por esse pagamento. |
|
is_past_due
|
items.is_past_due | boolean |
Se esse pagamento já passou da data da solicitação. |
|
reminder_was_sent
|
items.reminder_was_sent | boolean |
Se um lembrete de texto já foi enviado para esse pagamento. |
|
transaction_status
|
items.transaction_status | string |
O status da transação na authvia. Esse valor começa como Desconhecido. |
|
textrequest_payment_status
|
items.textrequest_payment_status | string |
O status da transação na Solicitação de Texto. Isso representa o status mostrado na página de pagamentos no aplicativo Solicitação de Texto. Ele começa como Enviado. |
|
reference_number
|
items.reference_number | string |
A ID definida pelo usuário definida quando são criados pagamentos que podem ser usados para localizar pagamentos rapidamente. Os números de referência não são exclusivos; muitos pagamentos podem ter a mesma referência. |
Gatilhos
| Dispara quando um texto é enviado ou recebido |
Dispara quando um texto é enviado ou recebido |
Dispara quando um texto é enviado ou recebido
Dispara quando um texto é enviado ou recebido
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Painel do qual o gatilho ouvirá eventos de
|
dashboard_id | True | string |
ID do painel para adicionar gatilho a |
|
evento
|
event | True | string |
evento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID exclusiva da mensagem
|
messageUniqueIdentifier | string |
messageUniqueIdentifier |
|
ID da conta
|
account.id | integer |
id |
|
ID da Conversa
|
yourPhoneNumber.id | integer |
id |
|
Nome do painel
|
yourPhoneNumber.description | string |
descrição |
|
Número de telefone do painel
|
yourPhoneNumber.phoneNumber | string |
número de telefone |
|
ID do painel
|
conversation.id | integer |
id |
|
date
|
conversation.date | string |
date |
|
Número de telefone de contato
|
conversation.consumerPhoneNumber | string |
consumerPhoneNumber |
|
messageDirection
|
conversation.messageDirection | string |
messageDirection |
|
mensagem
|
conversation.message | string |
mensagem |
|
numSegments
|
conversation.numSegments | integer |
numSegments |
|
status
|
conversation.status | string |
status |
|
Conversa reivindicada por
|
conversation.claimedBy | string |
claimedBy |
|
Nome de Exibição de Contato
|
conversation.consumerFriendlyName | string |
consumerFriendlyName |
Definições
cadeia
Esse é o tipo de dados básico 'string'.