Pedido de Texto

O Text Request é uma plataforma de mensagens de texto empresarial criada para estimular o envolvimento do cliente. Criámos uma solução de mensagens plug-and-play para os seus problemas de comunicação diários, para que possa eliminar o ruído e ligar-se aos clientes a qualquer hora, em qualquer lugar. Saiba mais sobre como ajudamos líderes empresariais ocupados como você.

Este conector está disponível nos seguintes produtos e regiões:

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - 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
Email	apidev@textrequest.com

Metadados do conector
Editora	Pedido de Texto
Sítio Web	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 seus utilizadores com o Aranda Service Management Suite, a solução multilocatária que lhe permite gerir, integrar e automatizar processos e serviços empresariais. Crie, pesquise e atualize registros armazenados em qualquer espaço de trabalho (projeto) do ASMS, incluindo incidentes, requisitos e alterações, entre outros.

Pre-requisites

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.

Obtenção de 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 Aranda Service Management Suite (ASMS).
Obter o token de integração
Obtenha a URL da instância da API ASMS (ApiAsms) do Aranda Service Management.
Estabeleça uma conexão com o conector do Aranda Service Management Suite.
Selecione uma das seguintes funções oferecidas pelo conector:
Para obter 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 tickets, entre outras ações disponíveis.
Obter rastreabilidade de bilhetes.
Faça o download de anexos relacionados a um ticket.
Pesquisar artigos da base de dados de conhecimento (KB) no Aranda Service Management Suite.
Transfira anexos de artigos da base de dados de conhecimento (KB).
Crie, pesquise e atualize itens de configuração (CIs).
Permite às organizações resolver os seus pedidos de suporte interno, gerindo e agilizando o processo de resolução de problemas técnicos.
Permite o rastreamento de comunicações entre solicitantes e agentes de suporte.
Ofereça respostas automáticas para informar os solicitantes sobre o status de seu bilhete.

Resposta com êxito

Código	Nome	Description
200	OK	O pedido foi bem-sucedido
204	NãoConteúdo	Nenhum dado encontrado na solicitação

Erros e soluções comuns

Código	Nome	Description	Solução
400	Pedido Inválido	CritériosNecessidadesAlgunsArgumentos	Verifique se os parâmetros de pesquisa não estão vazios
400	Pedido Inválido	InvalidAdditionalFieldId	Verifique se os IDs dos campos adicionais estão corretos
400	Pedido Inválido	InvalidItemType	O tipo de caso está incorreto, altere o id do tipo de caso
400	Pedido Inválido	InvalidProjectId	A id do projeto está incorreta, altere a id do projeto à qual você associará o caso
400	Pedido Inválido	InvalidStateId	Verificar o status adicionado ao criar ou atualizar um Ticket
400	Pedido Inválido	InvalidUploadType	Ocorreu um erro ao anexar um ficheiro, Solicitar assistência de um administrador de sistema
400	Pedido Inválido	RequestNeedsSomeArguments	Verifique os campos obrigatórios do bilhete e adicione o valor correspondente destes no conector
400	Pedido Inválido	SearchListIsRequired	Solicite assistência de um administrador de sistema
400	Pedido Inválido	Nome do parâmetro: {Name parameter}	Verifique se as propriedades mencionadas no erro não são nulas
400	Pedido Inválido	É null parameter name: {Name parameter}	Verifique se as propriedades mencionadas no erro não são nulas
400	Pedido Inválido	ItemTypeIsRequired	Adicionar tipo de caso
400	Pedido Inválido	ModelIdIsEmpty	Adicione o parâmetro modelId. É obrigatório.
400	Pedido Inválido	StateIdIsEmpty	Adicione o parâmetro stateId. É obrigatório.
400	Pedido Inválido	ServiceIdIsEmpty	Adicione o parâmetro serviceId. É obrigatório.
400	Pedido Inválido	CategoriaIdIsEmpty	Adicione o parâmetro categoryId. É obrigatório.
400	Pedido Inválido	TypesListNeedsSomeArguments	Requer a adição do tipo de caso ao procurar tickets, Solicite assistência de um administrador de sistema
400	Pedido Inválido	'{PARAMETER_NAME}' AdditionalFieldIsRequired	O campo adicional «{PARAMETER_NAME}» é obrigatório
400	Pedido Inválido	ModeloNotActive	O modelo associado ao caso não está ativo
400	Pedido Inválido	FailedToCloseTaskPendingCloseTasksPredecessors	Se você tentar fechar o caso e o caso pai tiver tarefas pendentes para fechar
400	Pedido Inválido	DuplicatedObject	O Ci já existe na base de dados
400	Pedido Inválido	Nome do parâmetro EmptyValue: {PARAMETER_NAME}	O parâmetro {PARAMETER_NAME} é obrigatório
400	Pedido Inválido	Nome do parâmetro EmptyEnumeration: {PARAMETER_NAME}	O parâmetro {PARAMETER_NAME} é uma lista e é obrigatório
403	Proibido	DoNotHavePermissionForThisAction	Fale com o administrador do sistema para atribuir permissões

Código	Nome	Description	Solução
500	Erro Interno do Servidor		Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureExportExcel	Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureGetAdditionalFields	Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureGetCategoriesByService	Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureGetChangeFSC	Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureGetFields	Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureGetFieldsList	Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureGetFiles	Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureGetLookupValues	Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureGetMailTemplates	Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureGetModelByCategory	Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureGetOperators	Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureGetReassignmentReasons	Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureGetSimilarItems	Solicite assistência de um administrador de sistema
500	Erro Interno do Servidor	FailureSearchQuickManagement	Solicite assistência de um administrador de sistema

FAQ

Como recuperar os IDs dos atributos necessários para usar as diferentes ações no conector (por exemplo, projeto, serviço, categoria, grupo, especialista)?

Os IDs podem ser recuperados de várias maneiras:
- Usando o Aranda Query Manager, você pode criar um relatório que consulta a tabela do Aranda Service Management Suite (ASMS) onde os dados necessários estão localizados. Se você precisar de orientação 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 à sua instalação ASMS.
- Se você estiver usando uma instalação ASMS On Premise, poderá consultar a tabela ASMS onde os dados necessários estão localizados por meio de um cliente SQL.
- Via Centro de Suporte Aranda, criando um pedido de suporte através dos canais de contacto indicados no seguinte website Suporte.
Qual é o tamanho máximo de ficheiros a anexar ao utilizar a ação "Adicionar anexo"?

O tamanho máximo depende da configuração específica da sua instância/instalação ASMS. Por favor, pergunte ao seu administrador ASMS.
Qual é o nível de acesso aos dados exigido pela conta do técnico cujo token é usado na configuração da conexão ASMS exigida pelo conector?

O nível de acesso é o mesmo que a conta de técnico 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 do técnico cujo token será usado no conector deve ser nomeada ou simultânea?

Como o conector pode acessar a instância ASMS relacionada várias vezes por hora, é altamente recomendável que a conta seja do 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 ASMS?

Sim, 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 devem ser preenchidos, esses dados também são necessários ao enviar o caso através do conector.
O conector pode ser usado para instâncias ASMS em ambientes Cloud e On Premise?

Sim, ele pode ser usado em instalações Cloud e On Premise do ASMS. Em instalações no local, você deve considerar a conectividade entre o servidor ASMS e seu ambiente Power Automatic.
Tenho uma licença Power Automate que só me permite utilizar conectores Standard. Posso usar o conector ASMS?

Não é possível, o conector ASMS é do tipo Premium.
Quero criar fluxos no Power Automate que comecem 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 a partir de eventos que ocorrem no ASMS?

Sim, é possível. Recomendam-se os seguintes passos:
- Inicialize um gatilho "Quando uma solicitação HTTP for recebida" e crie um esquema JSON do corpo da solicitação contendo a estrutura de dados esperada para ser recebida do ASMS. Depois que o gatilho for criado, você receberá um HTTP POST URL (WebHook URL) para usar em sua instância ASMS. Não se esqueça de considerar o mecanismo de autenticação para acessar o 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 "Invoke Webhook" e, no 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 a partir de uma regra no ASMS, visite o seguinte link: Regra Webhook
- Teste a regra criada e valide que uma solicitação HTTP é enviada para a URL do WebHook e inicializa o fluxo no Power Automate.
Posso invocar pontos de extremidade ASMS REST API como ações de fluxos no Power Automate?

Sim, é possível. Use a ação "HTTP" e preencha os dados necessários nela (URI, Método, Cabeçalhos, Corpo, entre outros).

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Predefinição	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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de 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á automaticamente desarquivada se o cliente enviar uma mensagem para o seu número de Solicitação de Texto, ou se você enviar ao cliente uma mensagem do seu número de Solicitação de Texto. Arquivar conversas é uma boa maneira de remover a confusão dos clientes com quem você não planeja falar no futuro. Observe que, se um cliente enviar mensagens de texto em "STOP" para impedir que você envie mais mensagens SMS, a conversa será automaticamente arquivada.
Atualiza um grupo com o id fornecido	Atualiza o nome de um grupo usando a id numérica do grupo. Se a ID de 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, você terá que 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, enviando uma mensagem de texto ao usuário informando 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á 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 contacto	Cria ou atualiza um contato (dependendo se já existe um com o número de telefone fornecido).
Criar um novo painel com o nome e o número de telefone	Cria um novo painel na conta. Assim que o painel for criado, os administradores receberão um e-mail sobre a alteração e poderão começar a atribuir usuários. Esse ponto de extremidade pode criar um painel para quaisquer números provisionados. Você pode pesquisar números provisionados em um código de área específico usando GET /dashboards/provisioning. Se o número de telefone já estiver em uso, uma exceção de solicitação incorreta será lançada.
Desarquivar uma conversa	Desarquiva uma conversa. Quando uma conversa não for arquivada, ela aparecerá novamente na fila. ele também aparecerá em conversas retornadas pelo ponto de extremidade /conversations. Se uma conversa já não estiver arquivada, 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, apenas um lembrete pode ser enviado por pagamento
Enviar uma mensagem para o contato com o número de telefone fornecido	Envia uma mensagem (iniciar uma nova conversa se o número de telefone fornecido 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 será bem-sucedido mesmo se houver contatos que são 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". Utilize este ponto final para quando o pagamento for pago através de um meio diferente do portal de pedidos de pagamento. Isso fechará o pagamento e adicionará o valor do pagamento às suas estatísticas. Este ponto final não é necessário para pagamentos pagos através do portal de pagamentos enviado através de Pedido de Texto; Isso marcará automaticamente um pagamento como pago.
Obter informações sobre este painel específico	Retorna o nome e o telefone do painel.
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. Apenas o painel especificado será pesquisado; Não há pesquisa de nível de conta para um número disponível.
Obter todos os painéis em uma conta	Obtém todos os painéis em uma conta.
Obter um grupo pelo seu 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 o id especificado	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 de cada conversa.
Obtém todas as tags	Obtém todas as tags para este painel. As tags são exclusivas entre painéis.
Obtém todos os campos personalizados	Obtém todos os campos personalizados para este painel. Os campos personalizados são exclusivos entre painéis.
Obtém todos os grupos	Obtém todos os grupos para a conta do usuário.
Recebe todos os pagamentos	Recebe todos os pagamentos, incluindo pagamentos cancelados e pagos. Eles podem ser filtrados usando os parâmetros de consulta.
Receber 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.

Arquivar uma conversa

ID da Operação:: ArchiveConversation

Arquiva uma conversa, removendo-a dos resultados de todos os pontos de extremidade de recuperação de conversa. Uma conversa será automaticamente desarquivada se o cliente enviar uma mensagem para o seu número de Solicitação de Texto, ou se você enviar ao cliente uma mensagem do seu número de Solicitação de Texto. Arquivar conversas é uma boa maneira de remover a confusão dos clientes com quem você não planeja falar no futuro. Observe que, se um cliente enviar mensagens de texto em "STOP" para impedir que você envie mais mensagens SMS, a conversa será automaticamente arquivada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para 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 arquivar.

Devoluções

response: string

Atualiza um grupo com o id fornecido

ID da Operação:: UpdateGroup

Atualiza o nome de um grupo usando a id numérica do grupo. Se a ID de grupo passada não existir, a chamada falhará.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para 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 identificação numérica do grupo a ser atualizado.
Nome do grupo	name		string	O novo nome do grupo.
Nota do grupo	notes		string	Frase curta que descreve o grupo. Usado por conveniência.

Devoluções

Name	Caminho	Tipo	Description
id	id	integer	A identificação numérica do grupo.
group_member_count	group_member_count	integer	O número de membros do grupo.
is_keyword	is_keyword	boolean	Se este 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 inscrevem.
nome	name	string	O nome deste grupo.
Observações	notes	string	Quaisquer notas sobre este grupo.
last_message_sent_utc	last_message_sent_utc	string	Carimbo de data/hora de quando a última mensagem de grupo foi enviada para este grupo.

Atualizar o nome de um painel específico

ID da Operação:: UpdateDashboardsName

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, você terá que criar um novo painel com um POST e adicionar os contatos com uma exportação/importação em massa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para 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.

Devoluções

Name	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 mensagem de texto associado a este painel.

Cancela o pagamento especificado

ID da Operação:: CancelPayment

Cancela o pagamento especificado, enviando uma mensagem de texto ao usuário informando 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

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para 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 identificação numérica do pagamento a atualizar.

Devoluções

Name	Caminho	Tipo	Description
payment_id	payment_id	integer	A identificação numérica do pagamento.
request_date	request_date	string	O carimbo de data/hora de quando a mensagem inicial deste pagamento foi enfileirada para ser enviada.
destinatário	recipient	string	O nome do destinatário do pagamento. Isso pode 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 é usado apenas por usuários internos para contexto sobre pagamentos.
customer_phone	customer_phone	string	O número de telefone do contacto a quem está a ser enviado este pagamento.
amount_requested	amount_requested	float	O valor em dólares solicitado por este pagamento.
is_past_due	is_past_due	boolean	Se este pagamento já passou da data do pedido.
reminder_was_sent	reminder_was_sent	boolean	Se já foi enviado um lembrete de texto para este pagamento.
transaction_status	transaction_status	string	O status da transação em authvia. Esse valor começa como Desconhecido.
textrequest_payment_status	textrequest_payment_status	string	O status da transação em Solicitação de texto. Isso representa o status mostrado na página de pagamentos no aplicativo Solicitação de texto. Começa como Enviado.
reference_number	reference_number	string	O ID definido pelo usuário definido quando os pagamentos são criados que pode ser usado para encontrar pagamentos rapidamente. Os números de referência não são únicos; Muitos pagamentos podem ter a mesma referência.

Contatos de atualização em massa

ID da Operação:: BulkUpdateContacts

Somente o painel especificado terá contatos adicionados; Os contatos são organizados por painel e não há pesquisa no nível da conta para um número disponível.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes.
Número de telefone do contacto	phone_number		string	Número de telefone do contato a ser criado ou atualizado.
Nome próprio do contacto	first_name		string	O novo nome próprio do contacto.
Apelido do contacto	last_name		string	O novo sobrenome do contato.
Nome completo do contacto	display_name		string	O novo nome completo do contato. Este é o nome padrão exibido no aplicativo Web ao exibir contatos.
Se as mensagens deste contacto são suprimidas	is_suppressed		boolean	Determina se as conversas com esse contato são suprimidas e, portanto, não são enviadas para o topo da fila de mensagens quando recebidas.
Se as mensagens deste 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 deste contacto estão bloqueadas	is_blocked		boolean	Determina se as conversas com esse contato são bloqueadas e, portanto, não são recebidas ou armazenadas.
Motivo para suprimir este contacto	suppressed_reason		string	Frase que descreve o motivo da supressão do contacto.
Nota de contacto	note		string	Frase curta que descreve o contacto. Usado por conveniência. Isso nunca é mostrado ao contato.
Grupos de contacto	groups		array of integer	Matriz de ids inteiros referentes a grupos aos quais esse contato pertencerá.
Tags de contato	contact_tags		array of string	Matriz de guids referentes a tags anexadas a este contato.
ID do campo personalizado	id		string	Guid referindo-se a um campo personalizado.
Valor do campo personalizado	value		string	O valor deste contato para este campo personalizado.
Se a conversa atual com este contato foi resolvida	is_resolved		boolean	Determina se a conversa atual com esse contato foi resolvida. Quaisquer novos textos recebidos por este contato definirão isso como falso.

Devoluções

Name	Caminho	Tipo	Description
		array of object
número de telefone	phone_number	string	Número de telefone deste contacto.
first_name	first_name	string	Nome próprio deste contacto.
last_name	last_name	string	Apelido deste contacto.
display_name	display_name	string	Nome completo deste contacto. Este é 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 para o topo da fila de mensagens quando recebida.
is_archived	is_archived	boolean	Se a conversa com esse contato está 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 da supressão do contacto. Se is_suppressed for falso, isso será nulo.
Observação	note	string	Frase curta que descreve o contacto. Usado por conveniência. Isso nunca é mostrado ao contato.
groups	groups	array of integer	Matriz de ids inteiros referentes a grupos aos quais esse contato pertence.
contact_tags	contact_tags	array of string	Matriz de guids referentes a tags anexadas a este contato.
custom_fields	custom_fields	array of object	Matriz de ids de campo personalizado e valores definidos para este contato.
id	custom_fields.id	string	Guid referindo-se a um campo personalizado.
valor	custom_fields.value	string	O valor deste contato para este campo personalizado.
is_resolved	is_resolved	boolean	Se a conversa com esse contato está resolvida. Quaisquer novos textos recebidos por este contato definirão isso como falso.
first_contact_utc	first_contact_utc	string	Carimbo de data/hora de quando a primeira mensagem foi enviada para este contato.
opted_out_utc	opted_out_utc	string	Carimbo de data/hora de quando este contato optou por não receber mensagens.
last_msg_sent_utc	last_msg_sent_utc	string	Carimbo de data/hora de quando a última mensagem foi enviada para este contato.
last_msg_received_utc	last_msg_received_utc	string	Carimbo de data/hora de quando a última mensagem foi recebida deste contato.
total_msgs_sent	total_msgs_sent	integer	O número total de mensagens enviadas para este contacto.
total_msgs_received	total_msgs_received	integer	O número total de mensagens recebidas deste contacto.
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 foi criado.
last_contact_date_utc	last_contact_date_utc	string	Carimbo de data/hora de quando a última mensagem foi enviada ou recebida deste 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, denotando 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 de 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 por solicitação de texto.
delivery_status	last_message.delivery_status	string	Status atual desta mensagem. Pode ser 'envio', 'entregue', 'erro' ou 'envio'.
delivery_error	last_message.delivery_error	string	Erro que fez com que esta mensagem não fosse entregue. Se o delivery_status não for 'erro', esse valor será nulo.
mms_media	last_message.mms_media	array of string	Lista de urls apontando para os anexos desta mensagem. Todas as urls serão urls geradas por solicitação de texto.

Cria um novo grupo

ID da Operação:: CreateGroup

Cria um novo grupo com o nome fornecido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para 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 do grupo	notes		string	Frase curta que descreve o grupo. Usado por conveniência.

Devoluções

Name	Caminho	Tipo	Description
id	id	integer	A identificação numérica do grupo.
group_member_count	group_member_count	integer	O número de membros do grupo.
is_keyword	is_keyword	boolean	Se este 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 inscrevem.
nome	name	string	O nome deste grupo.
Observações	notes	string	Quaisquer notas sobre este grupo.
last_message_sent_utc	last_message_sent_utc	string	Carimbo de data/hora de quando a última mensagem de grupo foi enviada para este grupo.

Cria um novo pagamento

ID da Operação:: CreatePayment

Cria um novo pagamento com a mensagem fornecida para o contato fornecido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para 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 só é usada por usuários internos para contextualizar pagamentos.
Número de telefone do destinatário	customer_phone		string	Número de telefone do contacto para o qual este pagamento será enviado.
Valor solicitado em dólares	amount_requested		float	O valor em dólares solicitado por este pagamento.
Corpo de texto da mensagem de pagamento	message		string	Mensagem de texto para enviar para contato junto com link de pagamento.
Cadeia de referência do pagamento	reference_number		string	ID definido pelo usuário definido quando os pagamentos são criados que podem ser usados para encontrar pagamentos rapidamente. Os números de referência não são únicos; Muitos pagamentos podem ter a mesma referência.

Devoluções

Name	Caminho	Tipo	Description
payment_id	payment_id	integer	A identificação numérica do pagamento.
request_date	request_date	string	O carimbo de data/hora de quando a mensagem inicial deste pagamento foi enfileirada para ser enviada.
destinatário	recipient	string	O nome do destinatário do pagamento. Isso pode 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 é usado apenas por usuários internos para contexto sobre pagamentos.
customer_phone	customer_phone	string	O número de telefone do contacto a quem está a ser enviado este pagamento.
amount_requested	amount_requested	float	O valor em dólares solicitado por este pagamento.
is_past_due	is_past_due	boolean	Se este pagamento já passou da data do pedido.
reminder_was_sent	reminder_was_sent	boolean	Se já foi enviado um lembrete de texto para este pagamento.
transaction_status	transaction_status	string	O status da transação em authvia. Esse valor começa como Desconhecido.
textrequest_payment_status	textrequest_payment_status	string	O status da transação em Solicitação de texto. Isso representa o status mostrado na página de pagamentos no aplicativo Solicitação de texto. Começa como Enviado.
reference_number	reference_number	string	O ID definido pelo usuário definido quando os pagamentos são criados que pode ser usado para encontrar pagamentos rapidamente. Os números de referência não são únicos; Muitos pagamentos podem ter a mesma referência.

Criar ou atualizar um contacto

ID da Operação:: CreateContact

Cria ou atualiza um contato (dependendo se já existe um com o número de telefone fornecido).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes.
Número de telefone do contacto	phone_number	True	string	Número de telefone do contato a ser criado ou atualizado.
Nome próprio do contacto	first_name		string	O novo nome próprio do contacto.
Apelido do contacto	last_name		string	O novo sobrenome do contato.
Nome completo do contacto	display_name		string	O novo nome completo do contato. Este é o nome padrão exibido no aplicativo Web ao exibir contatos.
Se as mensagens deste contacto são suprimidas	is_suppressed		boolean	Determina se as conversas com esse contato são suprimidas e, portanto, não são enviadas para o topo da fila de mensagens quando recebidas.
Se as mensagens deste 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 deste contacto estão bloqueadas	is_blocked		boolean	Determina se as conversas com esse contato são bloqueadas e, portanto, não são recebidas ou armazenadas.
Motivo para suprimir este contacto	suppressed_reason		string	Frase que descreve o motivo da supressão do contacto.
Nota de Contacto	note		string	Frase curta que descreve o contacto. Usado por conveniência. Isso nunca é mostrado ao contato.
Grupos de Contacto	groups		array of integer	Matriz de ids inteiros referentes a grupos aos quais esse contato pertencerá.
Tags de contato	contact_tags		array of string	Matriz de guids referentes a tags anexadas a este contato.
ID do campo personalizado	id		string	Guid referindo-se a um campo personalizado.
Valor do campo personalizado	value		string	O valor deste contato para este campo personalizado.
Se a conversa atual com este contato foi resolvida	is_resolved		boolean	Determina se a conversa atual com esse contato foi resolvida. Quaisquer novos textos recebidos por este contato definirão isso como falso.

Devoluções

Name	Caminho	Tipo	Description
número de telefone	phone_number	string	Número de telefone deste contacto.
first_name	first_name	string	Nome próprio deste contacto.
last_name	last_name	string	Apelido deste contacto.
display_name	display_name	string	Nome completo deste contacto. Este é 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 para o topo da fila de mensagens quando recebida.
is_archived	is_archived	boolean	Se a conversa com esse contato está 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 da supressão do contacto. Se is_suppressed for falso, isso será nulo.
Observação	note	string	Frase curta que descreve o contacto. Usado por conveniência. Isso nunca é mostrado ao contato.
groups	groups	array of integer	Matriz de ids inteiros referentes a grupos aos quais esse contato pertence.
contact_tags	contact_tags	array of string	Matriz de guids referentes a tags anexadas a este contato.
custom_fields	custom_fields	array of object	Matriz de ids de campo personalizado e valores definidos para este contato.
id	custom_fields.id	string	Guid referindo-se a um campo personalizado.
valor	custom_fields.value	string	O valor deste contato para este campo personalizado.
is_resolved	is_resolved	boolean	Se a conversa com esse contato está resolvida. Quaisquer novos textos recebidos por este contato definirão isso como falso.
first_contact_utc	first_contact_utc	string	Carimbo de data/hora de quando a primeira mensagem foi enviada para este contato.
opted_out_utc	opted_out_utc	string	Carimbo de data/hora de quando este contato optou por não receber mensagens.
last_msg_sent_utc	last_msg_sent_utc	string	Carimbo de data/hora de quando a última mensagem foi enviada para este contato.
last_msg_received_utc	last_msg_received_utc	string	Carimbo de data/hora de quando a última mensagem foi recebida deste contato.
total_msgs_sent	total_msgs_sent	integer	O número total de mensagens enviadas para este contacto.
total_msgs_received	total_msgs_received	integer	O número total de mensagens recebidas deste contacto.
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 foi criado.
last_contact_date_utc	last_contact_date_utc	string	Carimbo de data/hora de quando a última mensagem foi enviada ou recebida deste 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, denotando 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 de 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 por solicitação de texto.
delivery_status	last_message.delivery_status	string	Status atual desta mensagem. Pode ser 'envio', 'entregue', 'erro' ou 'envio'.
delivery_error	last_message.delivery_error	string	Erro que fez com que esta mensagem não fosse entregue. Se o delivery_status não for 'erro', esse valor será nulo.
mms_media	last_message.mms_media	array of string	Lista de urls apontando para os anexos desta 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

ID da Operação:: CreateDashboard

Cria um novo painel na conta. Assim que o painel for criado, os administradores receberão um e-mail sobre a alteração e poderão começar a atribuir usuários. Esse ponto de extremidade pode criar um painel para quaisquer números provisionados. Você pode pesquisar números provisionados em um código de área específico usando GET /dashboards/provisioning. Se o número de telefone já estiver em uso, uma exceção de solicitação incorreta será lançada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
nome	name		string	O nome do painel.
phone	phone		string	O número de mensagem de texto associado a este painel.

Devoluções

Name	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 mensagem de texto associado a este painel.

Desarquivar uma conversa

ID da Operação:: UnarchiveConversation

Desarquiva uma conversa. Quando uma conversa não for arquivada, ela aparecerá novamente na fila. ele também aparecerá em conversas retornadas pelo ponto de extremidade /conversations. Se uma conversa já não estiver arquivada, esse método não terá efeito.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para 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 arquivar.

Devoluções

response: string

Enviar um texto de acompanhamento lembrando o usuário de pagar o pagamento especificado

ID da Operação:: SendPaymentReminder

Envia um lembrete para o contato para pagar o pagamento especificado. O conteúdo da mensagem é gerado automaticamente. Para evitar spam, apenas um lembrete pode ser enviado por pagamento

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para 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 identificação numérica do pagamento a atualizar.

Devoluções

Name	Caminho	Tipo	Description
payment_id	payment_id	integer	A identificação numérica do pagamento.
request_date	request_date	string	O carimbo de data/hora de quando a mensagem inicial deste pagamento foi enfileirada para ser enviada.
destinatário	recipient	string	O nome do destinatário do pagamento. Isso pode 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 é usado apenas por usuários internos para contexto sobre pagamentos.
customer_phone	customer_phone	string	O número de telefone do contacto a quem está a ser enviado este pagamento.
amount_requested	amount_requested	float	O valor em dólares solicitado por este pagamento.
is_past_due	is_past_due	boolean	Se este pagamento já passou da data do pedido.
reminder_was_sent	reminder_was_sent	boolean	Se já foi enviado um lembrete de texto para este pagamento.
transaction_status	transaction_status	string	O status da transação em authvia. Esse valor começa como Desconhecido.
textrequest_payment_status	textrequest_payment_status	string	O status da transação em Solicitação de texto. Isso representa o status mostrado na página de pagamentos no aplicativo Solicitação de texto. Começa como Enviado.
reference_number	reference_number	string	O ID definido pelo usuário definido quando os pagamentos são criados que pode ser usado para encontrar pagamentos rapidamente. Os números de referência não são únicos; Muitos pagamentos podem ter a mesma referência.

Enviar uma mensagem para o contato com o número de telefone fornecido

ID da Operação:: SendMessageByPhoneNumber

Envia uma mensagem (iniciar uma nova conversa se o número de telefone fornecido não tiver histórico de mensagens).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para 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 enviar.
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 é atualizado	status_callback		string	URL para que o aplicativo Web seja atingido com um comando POST sempre que o status desta mensagem passar de não entregue a enviado (ou erro).
URL de retorno de chamada para solicitações de localização se esta mensagem incluir uma	location_callback		string	URL de retorno de chamada de localização para acertar 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 post /mms (não incluído neste conector). Não serão aceites ligações de anexos externos.

Devoluções

Name	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, denotando 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 de 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 por solicitação de texto.
delivery_status	delivery_status	string	Status atual desta mensagem. Pode ser 'envio', 'entregue', 'erro' ou 'envio'.
delivery_error	delivery_error	string	Erro que fez com que esta mensagem não fosse entregue. Se o delivery_status não for 'erro', esse valor será nulo.
mms_media	mms_media	array of string	Lista de urls apontando para os anexos desta mensagem. Todas as urls serão urls geradas por solicitação de texto.

Exclui o contato com o número de telefone especificado

ID da Operação:: DeleteContact

Exclui o contato com o número de telefone especificado

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes.
Número de telefone do contacto	phone_number	True	string	Número de telefone do contato a ser excluído.

Devoluções

response: string

Exclui o grupo com a id especificada

ID da Operação:: DeleteGroup

Exclui o grupo com a id especificada. Isso será bem-sucedido mesmo se houver contatos que são membros do grupo (os contatos não serão excluídos).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para 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.

Devoluções

response: string

Exclui o painel especificado

ID da Operação:: DeleteDashboard

Exclui o painel especificado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes.

Devoluções

response: string

Marcar um pagamento como pago

ID da Operação:: MarkPaymentPaid

Fecha um pagamento como "pago". Utilize este ponto final para quando o pagamento for pago através de um meio diferente do portal de pedidos de pagamento. Isso fechará o pagamento e adicionará o valor do pagamento às suas estatísticas. Este ponto final não é necessário para pagamentos pagos através do portal de pagamentos enviado através de Pedido de Texto; Isso marcará automaticamente um pagamento como pago.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para 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 identificação numérica do pagamento a atualizar.

Devoluções

Name	Caminho	Tipo	Description
payment_id	payment_id	integer	A identificação numérica do pagamento.
request_date	request_date	string	O carimbo de data/hora de quando a mensagem inicial deste pagamento foi enfileirada para ser enviada.
destinatário	recipient	string	O nome do destinatário do pagamento. Isso pode 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 é usado apenas por usuários internos para contexto sobre pagamentos.
customer_phone	customer_phone	string	O número de telefone do contacto a quem está a ser enviado este pagamento.
amount_requested	amount_requested	float	O valor em dólares solicitado por este pagamento.
is_past_due	is_past_due	boolean	Se este pagamento já passou da data do pedido.
reminder_was_sent	reminder_was_sent	boolean	Se já foi enviado um lembrete de texto para este pagamento.
transaction_status	transaction_status	string	O status da transação em authvia. Esse valor começa como Desconhecido.
textrequest_payment_status	textrequest_payment_status	string	O status da transação em Solicitação de texto. Isso representa o status mostrado na página de pagamentos no aplicativo Solicitação de texto. Começa como Enviado.
reference_number	reference_number	string	O ID definido pelo usuário definido quando os pagamentos são criados que pode ser usado para encontrar pagamentos rapidamente. Os números de referência não são únicos; Muitos pagamentos podem ter a mesma referência.

Obter informações sobre este painel específico

ID da Operação:: GetDashboard

Retorna o nome e o telefone do painel.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes.

Devoluções

Name	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 mensagem de texto associado a este painel.

Obter todos os contatos que correspondem ao critério de filtragem especificado

ID da Operação:: GetContacts

Obtém todos os contatos que correspondem ao critério de filtragem especificado. Apenas o painel especificado será pesquisado; Não há pesquisa de nível de conta para um número disponível.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Número de telefone do contato para pesquisar por	contact_phone_number		string	Número de telefone pelo qual filtrar contatos.
Carimbo de data/hora de pesquisa 'Última mensagem enviada antes' na hora UTC	last_message_timestamp_before_utc		date-time	Tempo limite 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 'Última mensagem enviada depois' na hora UTC	last_message_timestamp_after_utc		date-time	Tempo limite para pesquisar contatos pela última mensagem enviada ou recebida. Nenhum contato cuja última mensagem enviada seja anterior a esse horário será mostrado.
Carimbo de data/hora de pesquisa 'Criado antes'	contact_created_before		date-time	Tempo limite para pesquisar contatos por quando eles foram criados. Nenhum contato criado após esse horário será mostrado.
Carimbo de data/hora de pesquisa 'Criado depois'	contact_created_after		date-time	Tempo limite para pesquisar contatos por quando eles foram criados. Nenhum contato criado antes desse horário será mostrado.
Se a conversa do contato foi resolvida	is_resolved		boolean	Procurar ou não contatos cujas conversas foram resolvidas.
Se o contato está bloqueado	is_blocked		boolean	Procurar ou não contatos que foram bloqueados.
Se o contato é arquivado	is_archived		boolean	Se deve procurar contactos que foram arquivados.
Se o contato é suprimido	is_suppressed		boolean	Se deve procurar contatos que foram suprimidos.
Se o contato optou por não participar	has_opted_out		boolean	Se deve procurar contactos que optaram por não receber mensagens.
Carimbo de data/hora de pesquisa 'Última mensagem enviada antes'	last_message_sent_before		date-time	Tempo limite para pesquisar contatos até quando a última mensagem foi enviada ao cliente. Nenhum contato que enviou mensagens após esse horário será mostrado. Usa carimbo de data/hora como hora local. Para filtrar por carimbo de data/hora na hora UTC, use last_message_sent_before_utc
Carimbo de data/hora de pesquisa 'Última mensagem enviada depois'	last_message_sent_after		date-time	Tempo limite para pesquisar contatos até quando a última mensagem foi enviada ao cliente. Nenhum contato cuja última mensagem enviada seja anterior a esse horário será mostrado. Usa carimbo de data/hora como hora local. Para filtrar por carimbo de data/hora na hora UTC, use last_message_sent_after_utc
Carimbo de data/hora de pesquisa 'Última mensagem recebida antes'	last_message_received_before		date-time	Tempo limite para pesquisa de contatos pela última mensagem recebida do cliente. Nenhum contato que recebeu mensagens após esse horário será mostrado. Usa carimbo de data/hora como hora local. Para filtrar por carimbo de data/hora na hora UTC, use last_message_sent_before_utc
Carimbo de data/hora de pesquisa 'Última mensagem recebida depois'	last_message_received_after		date-time	Tempo limite para pesquisa de contatos pela última mensagem recebida do cliente. Nenhum contato cuja última mensagem enviada seja anterior a esse horário será mostrado. Usa carimbo de data/hora como hora local. Para filtrar por carimbo de data/hora na hora UTC, use last_message_sent_before_utc
Tags de contato	tags		string	Lista separada por vírgulas de guids referentes a tags para filtrar contatos.
Grupos de Contacto	groups		string	Lista separada por vírgulas de ids inteiros referentes a grupos pelos quais 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 para filtrar 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 filtrar 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 filtrar por	custom_field_value_3		string	Valor referente ao terceiro campo personalizado pelo qual filtrar contatos.
Página de número para obter	page	True	integer	A página de entidades a obter. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última, uma matriz vazia será retornada.
Quantidade de cada entidade a obter por página	page_size	True	integer	O tamanho de cada página a obter. Ao obter valores, este é um tamanho máximo por página, com o acesso às páginas subsequentes feito pelo parâmetro page.
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes.

Devoluções

Name	Caminho	Tipo	Description
página	meta.page	integer	A página das entidades ficou. 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 na base 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 de Solicitação de texto.
número de telefone	items.phone_number	string	Número de telefone deste contacto.
first_name	items.first_name	string	Nome próprio deste contacto.
last_name	items.last_name	string	Apelido deste contacto.
display_name	items.display_name	string	Nome completo deste contacto. Este é 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 para o topo da fila de mensagens quando recebida.
is_archived	items.is_archived	boolean	Se a conversa com esse contato está 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 da supressão do contacto. Se is_suppressed for falso, isso será nulo.
Observação	items.note	string	Frase curta que descreve o contacto. Usado por conveniência. Isso nunca é mostrado ao contato.
groups	items.groups	array of integer	Matriz de ids inteiros referentes a grupos aos quais esse contato pertence.
contact_tags	items.contact_tags	array of string	Matriz de guids referentes a tags anexadas a este contato.
custom_fields	items.custom_fields	array of object	Matriz de ids de campo personalizado e valores definidos para este contato.
id	items.custom_fields.id	string	Guid referindo-se a um campo personalizado.
valor	items.custom_fields.value	string	O valor deste contato para este campo personalizado.
is_resolved	items.is_resolved	boolean	Se a conversa com esse contato está resolvida. Quaisquer novos textos recebidos por este contato definirão isso como falso.
first_contact_utc	items.first_contact_utc	string	Carimbo de data/hora de quando a primeira mensagem foi enviada para este contato.
opted_out_utc	items.opted_out_utc	string	Carimbo de data/hora de quando este contato optou por não receber mensagens.
last_msg_sent_utc	items.last_msg_sent_utc	string	Carimbo de data/hora de quando a última mensagem foi enviada para este contato.
last_msg_received_utc	items.last_msg_received_utc	string	Carimbo de data/hora de quando a última mensagem foi recebida deste contato.
total_msgs_sent	items.total_msgs_sent	integer	O número total de mensagens enviadas para este contacto.
total_msgs_received	items.total_msgs_received	integer	O número total de mensagens recebidas deste contacto.
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 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 deste 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, denotando 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 de 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 por solicitação de texto.
delivery_status	items.last_message.delivery_status	string	Status atual desta mensagem. Pode ser 'envio', 'entregue', 'erro' ou 'envio'.
delivery_error	items.last_message.delivery_error	string	Erro que fez com que esta mensagem não fosse entregue. Se o delivery_status não for 'erro', esse valor será nulo.
mms_media	items.last_message.mms_media	array of string	Lista de urls apontando para os anexos desta mensagem. Todas as urls serão urls geradas por solicitação de texto.

Obter todos os painéis em uma conta

ID da Operação:: GetDashboards

Obtém todos os painéis em uma conta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Página de número para obter	page		integer	A página de entidades a obter. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última, uma matriz vazia será retornada.
Quantidade de cada entidade a obter por página	page_size		integer	O tamanho de cada página a obter. Ao obter valores, este é um tamanho máximo por página, com o acesso às páginas subsequentes feito pelo parâmetro page.

Devoluções

Name	Caminho	Tipo	Description
página	meta.page	integer	A página das entidades ficou. 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 na base 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 do painel obtidas de 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 mensagem de texto associado a este painel.

Obter um grupo pelo seu ID

ID da Operação:: GetGroupById

Obtém o grupo com a id especificada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para 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 identificação numérica do grupo a obter.

Devoluções

Name	Caminho	Tipo	Description
id	id	integer	A identificação numérica do grupo.
group_member_count	group_member_count	integer	O número de membros do grupo.
is_keyword	is_keyword	boolean	Se este 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 inscrevem.
nome	name	string	O nome deste grupo.
Observações	notes	string	Quaisquer notas sobre este grupo.
last_message_sent_utc	last_message_sent_utc	string	Carimbo de data/hora de quando a última mensagem de grupo foi enviada para este grupo.

Obtém o contato com o número de telefone especificado

ID da Operação:: GetContactByPhoneNumber

Obtém o contato com o número de telefone especificado

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes.
Número de telefone do contacto	phone_number	True	string	Número de telefone do contato a ser obtido.

Devoluções

Name	Caminho	Tipo	Description
número de telefone	phone_number	string	Número de telefone deste contacto.
first_name	first_name	string	Nome próprio deste contacto.
last_name	last_name	string	Apelido deste contacto.
display_name	display_name	string	Nome completo deste contacto. Este é 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 para o topo da fila de mensagens quando recebida.
is_archived	is_archived	boolean	Se a conversa com esse contato está 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 da supressão do contacto. Se is_suppressed for falso, isso será nulo.
Observação	note	string	Frase curta que descreve o contacto. Usado por conveniência. Isso nunca é mostrado ao contato.
groups	groups	array of integer	Matriz de ids inteiros referentes a grupos aos quais esse contato pertence.
contact_tags	contact_tags	array of string	Matriz de guids referentes a tags anexadas a este contato.
custom_fields	custom_fields	array of object	Matriz de ids de campo personalizado e valores definidos para este contato.
id	custom_fields.id	string	Guid referindo-se a um campo personalizado.
valor	custom_fields.value	string	O valor deste contato para este campo personalizado.
is_resolved	is_resolved	boolean	Se a conversa com esse contato está resolvida. Quaisquer novos textos recebidos por este contato definirão isso como falso.
first_contact_utc	first_contact_utc	string	Carimbo de data/hora de quando a primeira mensagem foi enviada para este contato.
opted_out_utc	opted_out_utc	string	Carimbo de data/hora de quando este contato optou por não receber mensagens.
last_msg_sent_utc	last_msg_sent_utc	string	Carimbo de data/hora de quando a última mensagem foi enviada para este contato.
last_msg_received_utc	last_msg_received_utc	string	Carimbo de data/hora de quando a última mensagem foi recebida deste contato.
total_msgs_sent	total_msgs_sent	integer	O número total de mensagens enviadas para este contacto.
total_msgs_received	total_msgs_received	integer	O número total de mensagens recebidas deste contacto.
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 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 deste 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, denotando 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 de 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 por solicitação de texto.
delivery_status	last_message.delivery_status	string	Status atual desta mensagem. Pode ser 'envio', 'entregue', 'erro' ou 'envio'.
delivery_error	last_message.delivery_error	string	Erro que fez com que esta mensagem não fosse entregue. Se o delivery_status não for 'erro', esse valor será nulo.
mms_media	last_message.mms_media	array of string	Lista de urls apontando para os anexos desta mensagem. Todas as urls serão urls geradas por solicitação de texto.

Obtém o pagamento com o id especificado

ID da Operação:: GetPayment

Obtém o pagamento com a ID especificada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para 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 identificação numérica do pagamento a receber.

Devoluções

Name	Caminho	Tipo	Description
payment_id	payment_id	integer	A identificação numérica do pagamento.
request_date	request_date	string	O carimbo de data/hora de quando a mensagem inicial deste pagamento foi enfileirada para ser enviada.
destinatário	recipient	string	O nome do destinatário do pagamento. Isso pode 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 é usado apenas por usuários internos para contexto sobre pagamentos.
customer_phone	customer_phone	string	O número de telefone do contacto a quem está a ser enviado este pagamento.
amount_requested	amount_requested	float	O valor em dólares solicitado por este pagamento.
is_past_due	is_past_due	boolean	Se este pagamento já passou da data do pedido.
reminder_was_sent	reminder_was_sent	boolean	Se já foi enviado um lembrete de texto para este pagamento.
transaction_status	transaction_status	string	O status da transação em authvia. Esse valor começa como Desconhecido.
textrequest_payment_status	textrequest_payment_status	string	O status da transação em Solicitação de texto. Isso representa o status mostrado na página de pagamentos no aplicativo Solicitação de texto. Começa como Enviado.
reference_number	reference_number	string	O ID definido pelo usuário definido quando os pagamentos são criados que pode ser usado para encontrar pagamentos rapidamente. Os números de referência não são únicos; Muitos pagamentos podem ter a mesma referência.

Obtém todas as conversas para este painel

ID da Operação:: GetConversations

Obtém todas as conversas para este painel e inclui informações sobre a última mensagem de cada conversa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Tags de contato	tags		string	Lista separada por vírgulas de guids referentes a tags para filtrar conversas.
Se deseja mostrar apenas conversas resolvidas	show_unresolved_only		string	Se deve procurar apenas contatos cujas conversas foram resolvidas. Se isso for falso, conversas resolvidas e não resolvidas serão mostradas.
Inclusão ou não de conversas arquivadas	include_archived		string	Se deseja incluir conversas com contatos que foram arquivados.
Termo a filtrar por números de telefone e nome de contacto	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 número de telefone, a pesquisa retornará todas as conversas que corresponderem parcialmente a ele.
Página de número para obter	page		integer	A página de entidades a obter. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última, uma matriz vazia será retornada.
Quantidade de cada entidade a obter por página	page_size		integer	O tamanho de cada página a obter. Ao obter valores, este é um tamanho máximo por página, com o acesso às páginas subsequentes feito pelo parâmetro page.
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes.

Devoluções

Name	Caminho	Tipo	Description
página	meta.page	integer	A página das entidades ficou. 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 na base 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ção obtidas a partir de Solicitação de texto.
número de telefone	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, denotando 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 de 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 por solicitação de texto.
delivery_status	items.last_message.delivery_status	string	Status atual desta mensagem. Pode ser 'envio', 'entregue', 'erro' ou 'envio'.
delivery_error	items.last_message.delivery_error	string	Erro que fez com que esta mensagem não fosse entregue. Se o delivery_status não for 'erro', esse valor será nulo.
mms_media	items.last_message.mms_media	array of string	Lista de urls apontando para os anexos desta mensagem. Todas as urls serão urls geradas por solicitação de texto.

Obtém todas as tags

ID da Operação:: GetTags

Obtém todas as tags para este painel. As tags são exclusivas entre painéis.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes.
Página de número para obter	page	True	integer	A página de entidades a obter. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última, uma matriz vazia será retornada.
Quantidade de cada entidade a obter por página	page_size	True	integer	O tamanho de cada página a obter. Ao obter valores, este é um tamanho máximo por página, com o acesso às páginas subsequentes feito pelo parâmetro page.

Devoluções

Name	Caminho	Tipo	Description
página	meta.page	integer	A página das entidades ficou. 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 na base 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 tag obtidas de Solicitação de texto.
id	items.id	string	O id numérico da tag.
tag_color	items.tag_color	string	A cor da etiqueta. Este deve ser um código de cor hexadecimal válido.
etiqueta	items.tag	string	O nome da tag.

Obtém todos os campos personalizados

ID da Operação:: GetCustomFields

Obtém todos os campos personalizados para este painel. Os campos personalizados são exclusivos entre painéis.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes.

Devoluções

Name	Caminho	Tipo	Description
		array of object
id	id	string	A identificação numérica do campo.
nome	name	string	O nome do campo personalizado.

Obtém todos os grupos

ID da Operação:: GetGroups

Obtém todos os grupos para a conta do usuário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Página de número para obter	page	True	integer	A página de entidades a obter. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última, uma matriz vazia será retornada.
Quantidade de cada entidade a obter por página	page_size	True	integer	O tamanho de cada página a obter. Ao obter valores, este é um tamanho máximo por página, com o acesso às páginas subsequentes feito pelo parâmetro page.
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes.

Devoluções

Name	Caminho	Tipo	Description
página	meta.page	integer	A página das entidades ficou. 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 na base 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 de Solicitação de texto.
id	items.id	integer	A identificação 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	Se este 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 inscrevem.
nome	items.name	string	O nome deste grupo.
Observações	items.notes	string	Quaisquer notas sobre este 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 este grupo.

Recebe todos os pagamentos

ID da Operação:: GetPayments

Recebe todos os pagamentos, incluindo pagamentos cancelados e pagos. Eles podem ser filtrados usando os parâmetros de consulta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Cadeia de referência do pagamento	reference_number		string	ID definido pelo usuário definido quando os pagamentos são criados que podem ser usados para encontrar pagamentos rapidamente. Os números de referência não são únicos; Muitos pagamentos podem ter a mesma referência.
Número de telefone de pagamento	phone_number		string	Número de telefone do contacto para o qual este pagamento foi enviado.
Ordenar por	sort_type		string	Propriedade para ordenar os pagamentos. Pode ser "montante", "contato", "data", "status".
Direção de classificação	sort_direction		string	Direção para classificar os pagamentos. Pode ser "desc" para o maior para o menor, ou "asc" para o menor para o maior.
Página de número para obter	page	True	integer	A página de entidades a obter. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última, uma matriz vazia será retornada.
Quantidade de cada entidade a obter por página	page_size	True	integer	O tamanho de cada página a obter. Ao obter valores, este é um tamanho máximo por página, com o acesso às páginas subsequentes feito pelo parâmetro page.
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes.

Devoluções

Name	Caminho	Tipo	Description
página	meta.page	integer	A página das entidades ficou. 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 na base 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 a partir de Pedido de Texto.
payment_id	items.payment_id	integer	A identificação numérica do pagamento.
request_date	items.request_date	string	O carimbo de data/hora de quando a mensagem inicial deste pagamento foi enfileirada para ser enviada.
destinatário	items.recipient	string	O nome do destinatário do pagamento. Isso pode 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 é usado apenas por usuários internos para contexto sobre pagamentos.
customer_phone	items.customer_phone	string	O número de telefone do contacto a quem está a ser enviado este pagamento.
amount_requested	items.amount_requested	float	O valor em dólares solicitado por este pagamento.
is_past_due	items.is_past_due	boolean	Se este pagamento já passou da data do pedido.
reminder_was_sent	items.reminder_was_sent	boolean	Se já foi enviado um lembrete de texto para este pagamento.
transaction_status	items.transaction_status	string	O status da transação em authvia. Esse valor começa como Desconhecido.
textrequest_payment_status	items.textrequest_payment_status	string	O status da transação em Solicitação de texto. Isso representa o status mostrado na página de pagamentos no aplicativo Solicitação de texto. Começa como Enviado.
reference_number	items.reference_number	string	O ID definido pelo usuário definido quando os pagamentos são criados que pode ser usado para encontrar pagamentos rapidamente. Os números de referência não são únicos; Muitos pagamentos podem ter a mesma referência.

Receber mensagens de uma conversa pelo número de telefone de um contato

ID da Operação:: GetMessagesByContactPhone

Obtenha a conversa entre o painel especificado e o número de telefone.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Página de número para obter	page	True	integer	A página de entidades a obter. Ao obter valores, há um tamanho máximo por página, definido por page_size. Se a página for maior que a última, uma matriz vazia será retornada.
Quantidade de cada entidade a obter por página	page_size	True	integer	O tamanho de cada página a obter. Ao obter valores, este é um tamanho máximo por página, com o acesso às páginas subsequentes feito pelo parâmetro page.
Id do painel para fazer esta chamada	dashboard_id	True	integer	O painel do número de telefone para trabalhar. Uma única conta pode ter vários painéis, representando diferentes linhas telefônicas para os clientes.
Número de telefone do contato para pesquisar por	phone_number	True	string	Número de telefone do contato para receber mensagens.

Devoluções

Name	Caminho	Tipo	Description
página	meta.page	integer	A página das entidades ficou. 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 na base 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 a partir de 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, denotando 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 de 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 por solicitação de texto.
delivery_status	items.delivery_status	string	Status atual desta mensagem. Pode ser 'envio', 'entregue', 'erro' ou 'envio'.
delivery_error	items.delivery_error	string	Erro que fez com que esta mensagem não fosse entregue. Se o delivery_status não for 'erro', esse valor será nulo.
mms_media	items.mms_media	array of string	Lista de urls apontando para os anexos desta mensagem. Todas as urls serão urls geradas por solicitação de texto.

Acionadores

Aciona quando um texto é enviado ou recebido

ID da Operação:: TextingWebhook

Aciona quando um texto é enviado ou recebido

Parâmetros

Name	Chave	Necessário	Tipo	Description
Dashboard o gatilho ouvirá eventos de	dashboard_id	True	string	Id do painel para adicionar gatilho a
evento	event	True	string	evento

Devoluções

Name	Caminho	Tipo	Description
ID exclusivo da mensagem	messageUniqueIdentifier	string	messageUniqueIdentifier
ID da conta	account.id	integer	id
ID da Conversação	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	Número de telefone do consumidor
messageDirection	conversation.messageDirection	string	messageDirection
mensagem	conversation.message	string	mensagem
numSegments	conversation.numSegments	integer	numSegments
estado	conversation.status	string	estado
Conversa reivindicada por	conversation.claimedBy	string	reivindicadoPor
Nome de exibição do contato	conversation.consumerFriendlyName	string	consumidorFriendlyName

Definições

cadeia (de caracteres)

Este é o tipo de dados básico 'string'.

Partilhar via

Pedido de Texto

Aranda Service Management Suite (ASMS)

Pre-requisites

Obtenção de credenciais

Introdução ao conector

Resposta com êxito

Erros e soluções comuns

FAQ

A criar uma ligação

Padrão

Limites de Limitação

Ações

Arquivar uma conversa

Parâmetros

Devoluções

Atualiza um grupo com o id fornecido

Parâmetros

Devoluções

Atualizar o nome de um painel específico

Parâmetros

Devoluções

Cancela o pagamento especificado

Parâmetros

Devoluções

Contatos de atualização em massa

Parâmetros

Devoluções

Cria um novo grupo

Parâmetros

Devoluções

Cria um novo pagamento

Parâmetros

Devoluções

Criar ou atualizar um contacto

Parâmetros

Devoluções

Criar um novo painel com o nome e o número de telefone

Parâmetros

Devoluções

Desarquivar uma conversa

Parâmetros

Devoluções

Enviar um texto de acompanhamento lembrando o usuário de pagar o pagamento especificado

Parâmetros

Devoluções

Enviar uma mensagem para o contato com o número de telefone fornecido

Parâmetros

Devoluções

Exclui o contato com o número de telefone especificado

Parâmetros

Devoluções

Exclui o grupo com a id especificada

Parâmetros

Devoluções

Exclui o painel especificado

Parâmetros

Devoluções

Marcar um pagamento como pago

Parâmetros

Devoluções

Obter informações sobre este painel específico

Parâmetros

Devoluções

Obter todos os contatos que correspondem ao critério de filtragem especificado

Parâmetros

Devoluções

Obter todos os painéis em uma conta

Parâmetros

Devoluções

Obter um grupo pelo seu ID

Parâmetros

Devoluções

Obtém o contato com o número de telefone especificado

Parâmetros

Devoluções

Obtém o pagamento com o id especificado

Parâmetros

Devoluções

Obtém todas as conversas para este painel