Solicitud de texto

La solicitud de texto es una plataforma de texto empresarial creada para encender la involucración del cliente. Hemos creado una solución de mensajería plug-and-play para sus problemas de comunicación cotidianos, por lo que puede cortar el ruido y conectarse con los clientes en cualquier momento, en cualquier lugar. Obtenga más información sobre cómo ayudamos a los líderes empresariales ocupados como usted.

Este conector está disponible en los siguientes productos y regiones:

Service	Class	Regions
Copilot Studio	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas	Estándar	Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD)
Power Apps	Premium	Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Power Automate	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)

Contacto
Nombre	Compatibilidad con Text Request API
URL	https://www.textrequest.com/contact
Correo Electrónico	apidev@textrequest.com

Metadatos del conector
Publicador	Solicitud de texto
Sitio web	https://www.textrequest.com/
Directiva de privacidad	https://www.textrequest.com/privacy-policy/
Categorías	Comunicación; Ventas y CRM

Aranda Service Management Suite (ASMS)

Aumente la productividad de su empresa y transforme la experiencia de los usuarios con Aranda Service Management Suite, la solución multiinquilino que le permite administrar, integrar y automatizar procesos y servicios empresariales. Crear, buscar y actualizar registros almacenados en cualquier área de trabajo (proyecto) de ASMS, incluidos incidentes, requisitos y cambios, entre otros.

Requisitos previos

Tenga en cuenta los siguientes requisitos previos para continuar:

Una suscripción y una instancia de Aranda Service Management Suite (ASMS). Comience aquí: https://arandasoft.com/
Una suscripción activa de Microsoft Power Automate con funcionalidades del conector Premium.

Obtención de credenciales

Para realizar la autenticación, use el token de integración. En el vínculo siguiente encontrará información sobre cómo obtener el token de integración.

Introducción al conector

Requiere una suscripción a Aranda Service Management Suite (ASMS).
Obtención del token de integración
Obtenga la dirección URL de instancia de la API de ASMS de Aranda Service Management (ApiAsms).
Establezca una conexión con el conector de Aranda Service Management Suite.
Seleccione una de las siguientes funciones que ofrece el conector:
Para obtener documentación detallada sobre el conector, consulte https://docs.arandasoft.com/connectors

Puede usar este conector en los casos siguientes:

Crear, buscar y actualizar vales, entre otras acciones disponibles.
Obtenga la rastreabilidad de vales.
Descargue los datos adjuntos relacionados con un vale.
Busque artículos de knowledge base (KB) en Aranda Service Management Suite.
Descargue datos adjuntos de artículos de knowledge base (KB).
Crear, buscar y actualizar elementos de configuración (ICI).
Permite a las organizaciones resolver sus solicitudes de soporte técnico internas, administrar y simplificar el proceso de resolución de problemas técnicos.
Permite el seguimiento de las comunicaciones entre los solicitantes y los agentes de soporte técnico.
Ofrezca respuestas automatizadas para informar a los solicitantes del estado de su vale.

Respuesta exitosa

Código	Nombre	Description
200	OK	La solicitud fue exitosa
204	Sincontenido	No se encontraron datos en la solicitud

Errores y soluciones comunes

Código	Nombre	Description	Solución
400	Solicitud incorrecta	CriteriaNeedsSomeArguments	Compruebe que los parámetros de búsqueda no están vacíos
400	Solicitud incorrecta	InvalidAdditionalFieldId	Compruebe que los identificadores de los campos adicionales son correctos.
400	Solicitud incorrecta	InvalidItemType	El tipo de caso es incorrecto, cambie el identificador de tipo de caso.
400	Solicitud incorrecta	InvalidProjectId	El identificador del proyecto es incorrecto, cambie el identificador del proyecto al que asociará el caso.
400	Solicitud incorrecta	InvalidStateId	Compruebe el estado agregado al crear o actualizar un vale
400	Solicitud incorrecta	InvalidUploadType	Error al adjuntar un archivo, Solicitar asistencia del administrador del sistema
400	Solicitud incorrecta	RequestNeedsSomeArguments	Compruebe los campos obligatorios del vale y agregue el valor correspondiente de estos en el conector.
400	Solicitud incorrecta	SearchListIsRequired	Solicitar ayuda de un administrador del sistema
400	Solicitud incorrecta	Nombre del parámetro: {Name parameter}	Compruebe que las propiedades mencionadas en el error no son null
400	Solicitud incorrecta	Es un nombre de parámetro null: {Name parameter}	Compruebe que las propiedades mencionadas en el error no son null
400	Solicitud incorrecta	ItemTypeIsRequired	Agregar tipo de caso
400	Solicitud incorrecta	ModelIdIsEmpty	Agregue el parámetro modelId. Es necesario.
400	Solicitud incorrecta	StateIdIsEmpty	Agregue el parámetro stateId. Es necesario.
400	Solicitud incorrecta	ServiceIdIsEmpty	Agregue el parámetro serviceId. Es necesario.
400	Solicitud incorrecta	CategoryIdIsEmpty	Agregue el parámetro categoryId. Es necesario.
400	Solicitud incorrecta	TypesListNeedsSomeArguments	Requiere agregar el tipo de caso al buscar vales, Solicitar asistencia de un administrador del sistema
400	Solicitud incorrecta	'{PARAMETER_NAME}' AdditionalFieldIsRequired	El campo adicional '{PARAMETER_NAME}' es obligatorio
400	Solicitud incorrecta	ModelNotActive	El modelo asociado al caso no está activo
400	Solicitud incorrecta	FailedToCloseTaskPendingCloseTasksPredecessors	Si intenta cerrar el caso y el caso primario tiene tareas pendientes para cerrar
400	Solicitud incorrecta	DuplicatedObject	La ci ya existe en la base de datos
400	Solicitud incorrecta	Nombre del parámetro EmptyValue: {PARAMETER_NAME}	Se requiere el parámetro {PARAMETER_NAME}
400	Solicitud incorrecta	Nombre del parámetro EmptyEnumeration: {PARAMETER_NAME}	El parámetro {PARAMETER_NAME} es una lista y es necesaria
403	Prohibido	DoNotHavePermissionForThisAction	Hable con el administrador del sistema para asignar permisos.

Código	Nombre	Description	Solución
500	Error Interno del Servidor		Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureExportExcel	Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureGetAdditionalFields	Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureGetCategoriesByService	Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureGetChangeFSC	Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureGetFields	Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureGetFieldsList	Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureGetFiles	Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureGetLookupValues	Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureGetMailTemplates	Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureGetModelByCategory	Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureGetOperators	Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureGetReassignmentReasons	Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureGetSimilarItems	Solicitar ayuda de un administrador del sistema
500	Error Interno del Servidor	FailureSearchQuickManagement	Solicitar ayuda de un administrador del sistema

Preguntas más frecuentes

¿Cómo recuperar los identificadores de los atributos necesarios para usar las diferentes acciones del conector (por ejemplo, proyecto, servicio, categoría, grupo, especialista)?

Los identificadores se pueden recuperar de muchas maneras:
- Con el Administrador de consultas de Aranda, puede crear un informe que consulte la tabla Aranda Service Management Suite (ASMS) donde se encuentran los datos necesarios. Si necesita instrucciones sobre los objetos de datos de la solución, visite el vínculo https://docs.arandasoft.com/docs/database.html siguiente e identifique la versión de la base de datos de Aranda correspondiente a la instalación de ASMS.
- Si usa una instalación local de ASMS, puede consultar la tabla ASMS donde se encuentran los datos necesarios a través de un cliente SQL.
- A través del Centro de soporte técnico de Aranda, creando una solicitud de soporte técnico a través de los canales de contacto indicados en el siguiente sitio web soporte técnico.
¿Cuál es el tamaño máximo de los archivos que se van a adjuntar al usar la acción "Agregar datos adjuntos"?

El tamaño máximo depende de la configuración específica de la instancia o instalación de ASMS. Pregunte al administrador de ASMS.
¿Cuál es el nivel de acceso a datos requerido por la cuenta del técnico cuyo token se usa en la configuración de la conexión de ASMS requerida por el conector?

El nivel de acceso es el mismo que la cuenta del técnico que se usa en ASMS de forma periódica. En otras palabras, en función de los roles y permisos del técnico correspondiente en ASMS, se puede acceder a los datos con el conector.
¿Debe la cuenta del técnico cuyo token se usará en el conector se denominará o concurrente?

Dado que el conector puede acceder a la instancia de ASMS relacionada varias veces por hora, se recomienda encarecidamente que la cuenta sea un tipo con nombre.
¿La creación o modificación de casos mediante el conector sigue las mismas reglas de validación de datos presentes en la interfaz de ASMS?

Sí, sigue las mismas reglas de validación. Por ejemplo, al crear un caso para un proyecto, servicio y categoría específicos, si se deben rellenar campos nativos y adicionales, estos datos también son necesarios al enviar el caso a través del conector.
¿Se puede usar el conector para las instancias de ASMS en entornos locales y en la nube?

Sí, se puede usar en instalaciones locales y en la nube de ASMS. En Instalaciones locales, debe tener en cuenta la conectividad entre el servidor ASMS y el entorno de Power Automate.
Tengo una licencia de Power Automate que solo me permite usar conectores estándar. ¿Puedo usar el conector de ASMS?

No es posible, el conector de ASMS es de tipo Premium.
Quiero crear flujos en Power Automate que comiencen desde eventos en ASMS (por ejemplo, cuando se ha creado un caso, cuando se asigna un caso a un grupo específico). ¿Es posible usar desencadenadores que comienzan desde eventos que se producen en ASMS?

Sí, es posible. Se recomiendan los pasos siguientes:
- Inicialice un desencadenador "Cuando se recibe una solicitud HTTP" y cree un esquema JSON del cuerpo de la solicitud que contiene la estructura de datos que se espera que se reciba de ASMS. Una vez creado el desencadenador, obtendrá una dirección URL HTTP POST (dirección URL de webHook) que se usará en la instancia de ASMS. No olvide tener en cuenta el mecanismo de autenticación para acceder a la dirección URL del webHook (por ejemplo, token).
- Cree una regla de negocios en ASMS para el conjunto de condiciones que, cuando se cumplan, debe iniciar el flujo en Power Automate. Como acción dentro de la regla, seleccione "Invoke Webhook" (Invocar webhook) y, en la dirección URL de destino de invocación, escriba la dirección URL de webHook obtenida anteriormente, los parámetros que se van a enviar y el cuerpo de la solicitud (que debe coincidir con el esquema JSON del cuerpo de la solicitud). Para obtener más información sobre cómo invocar un webhook desde una regla en ASMS, visite el vínculo siguiente: Regla de webhook.
- Pruebe la regla creada y valide que se envía una solicitud HTTP a la dirección URL del webHook e inicializa el flujo en Power Automate.
¿Puedo invocar puntos de conexión de la API REST de ASMS como acciones desde flujos en Power Automate?

Sí, es posible. Use la acción "HTTP" y rellene los datos necesarios en él (URI, Método, Encabezados, Cuerpo, entre otros).

Creación de una conexión

El conector admite los siguientes tipos de autenticación:


Predeterminado	Parámetros para crear una conexión.	Todas las regiones	No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre	Tipo	Description	Obligatorio
Clave de API	securestring	La clave de API de esta API	Cierto

Limitaciones

Nombre	Llamadas	Período de renovación
Llamadas API por conexión	100	60 segundos

Acciones

Actualiza un grupo con el identificador especificado.	Actualiza el nombre de un grupo mediante el identificador numérico del grupo. Si el identificador de grupo pasado no existe, se producirá un error en la llamada.
Actualizar el nombre de un panel específico	Actualiza un panel. Esto no cambia el número de teléfono de un panel. Si desea un nuevo número con los contactos de otro panel, tendrá que crear un nuevo panel con post y agregar los contactos con una exportación o importación masiva.
Archivar una conversación	Archiva una conversación, quitándola de los resultados de todos los puntos de conexión de recuperación de conversación. Una conversación se desarchivará automáticamente si el cliente envía un texto al número de solicitud de texto o si envía al cliente un texto del número de solicitud de texto. Archivar conversaciones es una buena manera de quitar el desorden de los clientes a los que no planea hablar en el futuro. Tenga en cuenta que si un cliente envía mensajes sms en "STOP" para evitar que envíe mensajes SMS adicionales, la conversación se archiva automáticamente.
Cancela el pago especificado.	Cancela el pago especificado, que indica al usuario que se ha cancelado el pago. Los pagos no se pueden editar, por lo que cancelar y emitir un nuevo pago es la mejor manera de corregir un pago.
Contactos de actualización masiva	Solo el panel especificado tendrá contactos agregados; los contactos se organizan por panel y no hay ninguna búsqueda de nivel de cuenta para un número disponible.
Crea un nuevo grupo	Crea un nuevo grupo con el nombre proporcionado.
Crea un nuevo pago	Crea un nuevo pago con el mensaje proporcionado al contacto proporcionado.
Crear o actualizar un contacto	Crea o actualiza un contacto (dependiendo de si ya existe uno con el número de teléfono especificado).
Crear un nuevo panel con el nombre y el número de teléfono especificados	Crea un nuevo panel en la cuenta. Una vez creado el panel, los administradores se enviarán por correo electrónico sobre el cambio y podrán empezar a asignar usuarios. Este punto de conexión puede hacer un panel para cualquier número aprovisionado. Puede buscar números aprovisionados en un código de área específico mediante GET /dashboards/provisioning. Si el número de teléfono ya está en uso, se producirá una excepción de solicitud incorrecta.
Desarchivar una conversación	Desarchiva una conversación. Una vez que se desarchive una conversación, aparecerá de nuevo en la cola. también aparecerá en las conversaciones devueltas por el punto de conexión /conversations. Si una conversación ya no está archivada, este método no tiene ningún efecto.
Elimina el contacto con el número de teléfono especificado.	Elimina el contacto con el número de teléfono especificado.
Elimina el grupo con el identificador especificado.	Elimina el grupo con el identificador especificado. Esto se realizará correctamente incluso si hay contactos que son miembros del grupo (los contactos no se eliminarán).
Elimina el panel especificado.	Elimina el panel especificado.
Enviar un mensaje al contacto con el número de teléfono especificado	Envía un mensaje (iniciando una nueva conversación si el número de teléfono especificado no tiene historial de mensajes).
Enviar un texto de seguimiento que recuerde al usuario que paga el pago especificado	Envía un aviso al contacto para pagar el pago especificado. El contenido del mensaje se genera automáticamente. Para evitar el correo no deseado, solo se puede enviar un aviso por pago
Marcar un pago como pagado	Cierra un pago como "pagado". Use este punto de conexión para cuando el pago se pague a través de un medio distinto del portal de solicitudes de pago. Esto cerrará el pago y agregará su importe de pago a sus estadísticas. Este punto de conexión no es necesario para los pagos pagados a través del portal de pagos enviado a través de la solicitud de texto; que marcará automáticamente un pago como pagado.
Obtener información sobre este panel específico	Devuelve el nombre y el teléfono del panel.
Obtener los mensajes de una conversación por el número de teléfono de un contacto	Obtenga la conversación entre el panel y el número de teléfono especificados.
Obtener todos los contactos que coincidan con el criterio de filtrado especificado	Obtiene todos los contactos que coinciden con el criterio de filtrado especificado. Solo se buscará en el panel especificado; no hay ninguna búsqueda de nivel de cuenta para un número disponible.
Obtener todos los paneles de una cuenta	Obtiene todos los paneles de una cuenta.
Obtener un grupo por su identificador	Obtiene el grupo con el identificador especificado.
Obtiene el contacto con el número de teléfono especificado.	Obtiene el contacto con el número de teléfono especificado.
Obtiene el pago con el identificador especificado.	Obtiene el pago con el identificador especificado.
Obtiene todas las conversaciones de este panel.	Obtiene todas las conversaciones de este panel e incluye información sobre el último mensaje de cada conversación.
Obtiene todas las etiquetas.	Obtiene todas las etiquetas de este panel. Las etiquetas son únicas entre paneles.
Obtiene todos los campos personalizados.	Obtiene todos los campos personalizados de este panel. Los campos personalizados son únicos entre paneles.
Obtiene todos los grupos.	Obtiene todos los grupos de la cuenta del usuario.
Obtiene todos los pagos	Obtiene todos los pagos, incluidos los pagos cancelados y pagados. Estos se pueden filtrar mediante los parámetros de consulta.

Actualiza un grupo con el identificador especificado.

Id. de la operación:: UpdateGroup

Actualiza el nombre de un grupo mediante el identificador numérico del grupo. Si el identificador de grupo pasado no existe, se producirá un error en la llamada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Identificador del grupo	group_id	True	integer	Identificador numérico del grupo que se va a actualizar.
Nombre del grupo	name		string	Nuevo nombre del grupo.
Nota de grupo	notes		string	Frase corta que describe el grupo. Se usa para mayor comodidad.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador numérico del grupo.
group_member_count	group_member_count	integer	Número de miembros del grupo.
is_keyword	is_keyword	boolean	Wheter this group is a keyword group. Estos grupos se generan automáticamente cuando un usuario configura una palabra clave. Los contactos se agregan automáticamente cuando se inscriben.
nombre	name	string	Nombre de este grupo.
notas	notes	string	Cualquier nota de este grupo.
last_message_sent_utc	last_message_sent_utc	string	Marca de tiempo de cuándo se envió el último mensaje de grupo para este grupo.

Actualizar el nombre de un panel específico

Id. de la operación:: UpdateDashboardsName

Actualiza un panel. Esto no cambia el número de teléfono de un panel. Si desea un nuevo número con los contactos de otro panel, tendrá que crear un nuevo panel con post y agregar los contactos con una exportación o importación masiva.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Nombre del panel	name		string	Nuevo nombre del panel.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador numérico del panel.
nombre	name	string	Nombre del panel.
phone	phone	string	Número de texto asociado a este panel.

Archivar una conversación

Id. de la operación:: ArchiveConversation

Archiva una conversación, quitándola de los resultados de todos los puntos de conexión de recuperación de conversación. Una conversación se desarchivará automáticamente si el cliente envía un texto al número de solicitud de texto o si envía al cliente un texto del número de solicitud de texto. Archivar conversaciones es una buena manera de quitar el desorden de los clientes a los que no planea hablar en el futuro. Tenga en cuenta que si un cliente envía mensajes sms en "STOP" para evitar que envíe mensajes SMS adicionales, la conversación se archiva automáticamente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Número de teléfono de conversación	phone_number	True	string	Número de teléfono de la conversación que se va a archivar.

Devoluciones

response: string

Cancela el pago especificado.

Id. de la operación:: CancelPayment

Cancela el pago especificado, que indica al usuario que se ha cancelado el pago. Los pagos no se pueden editar, por lo que cancelar y emitir un nuevo pago es la mejor manera de corregir un pago.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Identificador del pago	payment_id	True	integer	Identificador numérico del pago que se va a actualizar.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
payment_id	payment_id	integer	Identificador numérico del pago.
request_date	request_date	string	Marca de tiempo de cuándo se puso en cola el mensaje inicial de este pago para enviarse.
destinatario	recipient	string	Nombre del destinatario del pago. Puede ser null si el contacto no tiene un nombre asociado a su número de teléfono.
descripción	description	string	Descripción del pago. Esto no se muestra al contacto. Solo lo usan los usuarios internos para el contexto sobre los pagos.
customer_phone	customer_phone	string	Número de teléfono del contacto que se envía este pago.
amount_requested	amount_requested	float	Importe en dólares solicitados por este pago.
is_past_due	is_past_due	boolean	Si este pago ha pasado la fecha de solicitud.
reminder_was_sent	reminder_was_sent	boolean	Si ya se ha enviado un aviso de texto para este pago.
transaction_status	transaction_status	string	Estado de la transacción en authvia. Este valor se inicia como Desconocido.
textrequest_payment_status	textrequest_payment_status	string	Estado de la transacción en Solicitud de texto. Esto representa ese estado que se muestra en la página de pagos de la aplicación Solicitud de texto. Se inicia como Enviado.
reference_number	reference_number	string	Identificador definido por el usuario cuando se crean pagos que se pueden usar para encontrar rápidamente los pagos. Los números de referencia no son únicos; muchos pagos pueden tener la misma referencia.

Contactos de actualización masiva

Id. de la operación:: BulkUpdateContacts

Solo el panel especificado tendrá contactos agregados; los contactos se organizan por panel y no hay ninguna búsqueda de nivel de cuenta para un número disponible.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Número de teléfono de contacto	phone_number		string	Número de teléfono del contacto para crear o actualizar.
Nombre del contacto	first_name		string	Nuevo nombre del contacto.
Apellidos de contacto	last_name		string	Nuevo apellido del contacto.
Nombre completo del contacto	display_name		string	Nuevo nombre completo del contacto. Este es el nombre predeterminado que se muestra en la aplicación web al ver los contactos.
Si se suprimen los mensajes de este contacto	is_suppressed		boolean	Determina si se suprimen las conversaciones con este contacto y, por tanto, no se insertan en la parte superior de la cola de mensajes cuando se reciben.
Si se archivan los mensajes de este contacto	is_archived		boolean	Determina si las conversaciones con este contacto se archivan y, por tanto, no se pueden ver al consultar conversaciones (de forma predeterminada).
Indica si los mensajes de este contacto están bloqueados	is_blocked		boolean	Determina si las conversaciones con este contacto están bloqueadas y, por lo tanto, no se reciben o almacenan.
Motivo para suprimir este contacto	suppressed_reason		string	Frase que describe el motivo para suprimir el contacto.
Nota de contacto	note		string	Frase corta que describe el contacto. Se usa para mayor comodidad. Esto nunca se muestra al contacto.
Grupos de contactos	groups		array of integer	Matriz de identificadores enteros que hacen referencia a grupos a los que pertenece este contacto.
Etiquetas de contacto	contact_tags		array of string	Matriz de guides que hacen referencia a etiquetas adjuntas a este contacto.
Identificador de campo personalizado	id		string	Guid que hace referencia a un campo personalizado.
Valor de campo personalizado	value		string	El valor de este contacto para este campo personalizado.
Si se ha resuelto la conversación actual con este contacto	is_resolved		boolean	Determina si se resuelve la conversación actual con este contacto. Los nuevos textos recibidos por este contacto establecerán este false.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
		array of object
número_de_teléfono	phone_number	string	Número de teléfono de este contacto.
first_name	first_name	string	Nombre de este contacto.
last_name	last_name	string	Apellidos de este contacto.
display_name	display_name	string	Nombre completo de este contacto. Este es el nombre predeterminado que se muestra en la aplicación web al ver los contactos.
is_suppressed	is_suppressed	boolean	Si se suprime la conversación con este contacto y, por tanto, no se inserta en la parte superior de la cola de mensajes cuando se recibe.
is_archived	is_archived	boolean	Si la conversación con este contacto se archiva y, por tanto, no se puede ver al consultar conversaciones (de forma predeterminada).
is_blocked	is_blocked	boolean	Indica si la conversación con este contacto está bloqueada y, por tanto, no se recibe ni almacena.
suppressed_reason	suppressed_reason	string	Frase que describe el motivo para suprimir el contacto. Si is_suppressed es false, será null.
nota	note	string	Frase corta que describe el contacto. Se usa para mayor comodidad. Esto nunca se muestra al contacto.
groups	groups	array of integer	Matriz de identificadores enteros a los que hace referencia a los grupos a los que pertenece este contacto.
contact_tags	contact_tags	array of string	Matriz de guides que hacen referencia a etiquetas adjuntas a este contacto.
custom_fields	custom_fields	array of object	Matriz de identificadores y valores de campo personalizados definidos para este contacto.
id	custom_fields.id	string	Guid que hace referencia a un campo personalizado.
value	custom_fields.value	string	El valor de este contacto para este campo personalizado.
is_resolved	is_resolved	boolean	Si se resuelve la conversación con este contacto. Los nuevos textos recibidos por este contacto establecerán este false.
first_contact_utc	first_contact_utc	string	Marca de tiempo de cuándo se envió el primer mensaje a este contacto.
opted_out_utc	opted_out_utc	string	Marca de tiempo de cuando este contacto optó por no recibir mensajes.
last_msg_sent_utc	last_msg_sent_utc	string	Marca de tiempo de cuándo se envió el último mensaje a este contacto.
last_msg_received_utc	last_msg_received_utc	string	Marca de tiempo de cuando se recibió el último mensaje de este contacto.
total_msgs_sent	total_msgs_sent	integer	Número de mensajes totales enviados a este contacto.
total_msgs_received	total_msgs_received	integer	Número de mensajes totales recibidos de este contacto.
response_count	response_count	integer	Número total de mensajes de respuesta del contacto.
date_created_utc	date_created_utc	string	Marca de tiempo de cuándo se creó el contacto.
last_contact_date_utc	last_contact_date_utc	string	Marca de tiempo de cuándo se envió o recibió el último mensaje de este contacto.
message_id	last_message.message_id	string	Id. del mensaje. Este valor es único para cada mensaje.
body	last_message.body	string	Contenido de este mensaje.
message_direction	last_message.message_direction	string	Carácter singular, ya sea R o S, que indica si este mensaje se recibió del contacto o se les envió, respectivamente.
response_by_username	last_message.response_by_username	string	Nombre de usuario del usuario solicitud de texto que envió por última vez un mensaje a este usuario.
message_timestamp_utc	last_message.message_timestamp_utc	string	Marca de tiempo de cuando la solicitud de texto envió o recibió el mensaje.
delivery_status	last_message.delivery_status	string	Estado actual de este mensaje. Esto puede ser "send", "delivered", "error" o "send".
delivery_error	last_message.delivery_error	string	Error que provocó que este mensaje no se entregue. Si el delivery_status no es "error", este valor será NULL.
mms_media	last_message.mms_media	array of string	Lista de direcciones URL que apuntan a los datos adjuntos de este mensaje. Todas las direcciones URL serán direcciones URL generadas por la solicitud de texto.

Crea un nuevo grupo

Id. de la operación:: CreateGroup

Crea un nuevo grupo con el nombre proporcionado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Nombre del grupo	name		string	Nuevo nombre del grupo.
Nota de grupo	notes		string	Frase corta que describe el grupo. Se usa para mayor comodidad.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador numérico del grupo.
group_member_count	group_member_count	integer	Número de miembros del grupo.
is_keyword	is_keyword	boolean	Wheter this group is a keyword group. Estos grupos se generan automáticamente cuando un usuario configura una palabra clave. Los contactos se agregan automáticamente cuando se inscriben.
nombre	name	string	Nombre de este grupo.
notas	notes	string	Cualquier nota de este grupo.
last_message_sent_utc	last_message_sent_utc	string	Marca de tiempo de cuándo se envió el último mensaje de grupo para este grupo.

Crea un nuevo pago

Id. de la operación:: CreatePayment

Crea un nuevo pago con el mensaje proporcionado al contacto proporcionado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Descripción del pago	description		string	Descripción del pago. La descripción no se muestra al contacto y solo la usan los usuarios internos para el contexto sobre los pagos.
Número de teléfono del destinatario	customer_phone		string	Número de teléfono del contacto al que se enviará este pago.
Importe solicitado en dólares	amount_requested		float	Importe en dólares solicitados por este pago.
Cuerpo del texto del mensaje de pago	message		string	Texto del mensaje que se va a enviar al contacto junto con el vínculo de pago.
Cadena de referencia del pago	reference_number		string	Identificador definido por el usuario cuando se crean pagos que se pueden usar para encontrar rápidamente pagos. Los números de referencia no son únicos; muchos pagos pueden tener la misma referencia.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
payment_id	payment_id	integer	Identificador numérico del pago.
request_date	request_date	string	Marca de tiempo de cuándo se puso en cola el mensaje inicial de este pago para enviarse.
destinatario	recipient	string	Nombre del destinatario del pago. Puede ser null si el contacto no tiene un nombre asociado a su número de teléfono.
descripción	description	string	Descripción del pago. Esto no se muestra al contacto. Solo lo usan los usuarios internos para el contexto sobre los pagos.
customer_phone	customer_phone	string	Número de teléfono del contacto que se envía este pago.
amount_requested	amount_requested	float	Importe en dólares solicitados por este pago.
is_past_due	is_past_due	boolean	Si este pago ha pasado la fecha de solicitud.
reminder_was_sent	reminder_was_sent	boolean	Si ya se ha enviado un aviso de texto para este pago.
transaction_status	transaction_status	string	Estado de la transacción en authvia. Este valor se inicia como Desconocido.
textrequest_payment_status	textrequest_payment_status	string	Estado de la transacción en Solicitud de texto. Esto representa ese estado que se muestra en la página de pagos de la aplicación Solicitud de texto. Se inicia como Enviado.
reference_number	reference_number	string	Identificador definido por el usuario cuando se crean pagos que se pueden usar para encontrar rápidamente los pagos. Los números de referencia no son únicos; muchos pagos pueden tener la misma referencia.

Crear o actualizar un contacto

Id. de la operación:: CreateContact

Crea o actualiza un contacto (dependiendo de si ya existe uno con el número de teléfono especificado).

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Número de teléfono de contacto	phone_number	True	string	Número de teléfono del contacto para crear o actualizar.
Nombre del contacto	first_name		string	Nuevo nombre del contacto.
Apellidos de contacto	last_name		string	Nuevo apellido del contacto.
Nombre completo del contacto	display_name		string	Nuevo nombre completo del contacto. Este es el nombre predeterminado que se muestra en la aplicación web al ver los contactos.
Si se suprimen los mensajes de este contacto	is_suppressed		boolean	Determina si se suprimen las conversaciones con este contacto y, por tanto, no se insertan en la parte superior de la cola de mensajes cuando se reciben.
Si se archivan los mensajes de este contacto	is_archived		boolean	Determina si las conversaciones con este contacto se archivan y, por tanto, no se pueden ver al consultar conversaciones (de forma predeterminada).
Indica si los mensajes de este contacto están bloqueados	is_blocked		boolean	Determina si las conversaciones con este contacto están bloqueadas y, por lo tanto, no se reciben o almacenan.
Motivo para suprimir este contacto	suppressed_reason		string	Frase que describe el motivo para suprimir el contacto.
Nota de contacto	note		string	Frase corta que describe el contacto. Se usa para mayor comodidad. Esto nunca se muestra al contacto.
Grupos de contactos	groups		array of integer	Matriz de identificadores enteros que hacen referencia a grupos a los que pertenece este contacto.
Etiquetas de contacto	contact_tags		array of string	Matriz de guides que hacen referencia a etiquetas adjuntas a este contacto.
Identificador de campo personalizado	id		string	Guid que hace referencia a un campo personalizado.
Valor de campo personalizado	value		string	El valor de este contacto para este campo personalizado.
Si se ha resuelto la conversación actual con este contacto	is_resolved		boolean	Determina si se resuelve la conversación actual con este contacto. Los nuevos textos recibidos por este contacto establecerán este false.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
número_de_teléfono	phone_number	string	Número de teléfono de este contacto.
first_name	first_name	string	Nombre de este contacto.
last_name	last_name	string	Apellidos de este contacto.
display_name	display_name	string	Nombre completo de este contacto. Este es el nombre predeterminado que se muestra en la aplicación web al ver los contactos.
is_suppressed	is_suppressed	boolean	Si se suprime la conversación con este contacto y, por tanto, no se inserta en la parte superior de la cola de mensajes cuando se recibe.
is_archived	is_archived	boolean	Si la conversación con este contacto se archiva y, por tanto, no se puede ver al consultar conversaciones (de forma predeterminada).
is_blocked	is_blocked	boolean	Indica si la conversación con este contacto está bloqueada y, por tanto, no se recibe ni almacena.
suppressed_reason	suppressed_reason	string	Frase que describe el motivo para suprimir el contacto. Si is_suppressed es false, será null.
nota	note	string	Frase corta que describe el contacto. Se usa para mayor comodidad. Esto nunca se muestra al contacto.
groups	groups	array of integer	Matriz de identificadores enteros a los que hace referencia a los grupos a los que pertenece este contacto.
contact_tags	contact_tags	array of string	Matriz de guides que hacen referencia a etiquetas adjuntas a este contacto.
custom_fields	custom_fields	array of object	Matriz de identificadores y valores de campo personalizados definidos para este contacto.
id	custom_fields.id	string	Guid que hace referencia a un campo personalizado.
value	custom_fields.value	string	El valor de este contacto para este campo personalizado.
is_resolved	is_resolved	boolean	Si se resuelve la conversación con este contacto. Los nuevos textos recibidos por este contacto establecerán este false.
first_contact_utc	first_contact_utc	string	Marca de tiempo de cuándo se envió el primer mensaje a este contacto.
opted_out_utc	opted_out_utc	string	Marca de tiempo de cuando este contacto optó por no recibir mensajes.
last_msg_sent_utc	last_msg_sent_utc	string	Marca de tiempo de cuándo se envió el último mensaje a este contacto.
last_msg_received_utc	last_msg_received_utc	string	Marca de tiempo de cuando se recibió el último mensaje de este contacto.
total_msgs_sent	total_msgs_sent	integer	Número de mensajes totales enviados a este contacto.
total_msgs_received	total_msgs_received	integer	Número de mensajes totales recibidos de este contacto.
response_count	response_count	integer	Número total de mensajes de respuesta del contacto.
date_created_utc	date_created_utc	string	Marca de tiempo de cuándo se creó el contacto.
last_contact_date_utc	last_contact_date_utc	string	Marca de tiempo de cuándo se envió o recibió el último mensaje de este contacto.
message_id	last_message.message_id	string	Id. del mensaje. Este valor es único para cada mensaje.
body	last_message.body	string	Contenido de este mensaje.
message_direction	last_message.message_direction	string	Carácter singular, ya sea R o S, que indica si este mensaje se recibió del contacto o se les envió, respectivamente.
response_by_username	last_message.response_by_username	string	Nombre de usuario del usuario solicitud de texto que envió por última vez un mensaje a este usuario.
message_timestamp_utc	last_message.message_timestamp_utc	string	Marca de tiempo de cuando la solicitud de texto envió o recibió el mensaje.
delivery_status	last_message.delivery_status	string	Estado actual de este mensaje. Esto puede ser "send", "delivered", "error" o "send".
delivery_error	last_message.delivery_error	string	Error que provocó que este mensaje no se entregue. Si el delivery_status no es "error", este valor será NULL.
mms_media	last_message.mms_media	array of string	Lista de direcciones URL que apuntan a los datos adjuntos de este mensaje. Todas las direcciones URL serán direcciones URL generadas por la solicitud de texto.

Crear un nuevo panel con el nombre y el número de teléfono especificados

Id. de la operación:: CreateDashboard

Crea un nuevo panel en la cuenta. Una vez creado el panel, los administradores se enviarán por correo electrónico sobre el cambio y podrán empezar a asignar usuarios. Este punto de conexión puede hacer un panel para cualquier número aprovisionado. Puede buscar números aprovisionados en un código de área específico mediante GET /dashboards/provisioning. Si el número de teléfono ya está en uso, se producirá una excepción de solicitud incorrecta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
nombre	name		string	Nombre del panel.
phone	phone		string	Número de texto asociado a este panel.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador numérico del panel.
nombre	name	string	Nombre del panel.
phone	phone	string	Número de texto asociado a este panel.

Desarchivar una conversación

Id. de la operación:: UnarchiveConversation

Desarchiva una conversación. Una vez que se desarchive una conversación, aparecerá de nuevo en la cola. también aparecerá en las conversaciones devueltas por el punto de conexión /conversations. Si una conversación ya no está archivada, este método no tiene ningún efecto.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Número de teléfono de conversación	phone_number	True	string	Número de teléfono de la conversación que se va a archivar.

Devoluciones

response: string

Elimina el contacto con el número de teléfono especificado.

Id. de la operación:: DeleteContact

Elimina el contacto con el número de teléfono especificado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Número de teléfono de contacto	phone_number	True	string	Número de teléfono del contacto que se va a eliminar.

Devoluciones

response: string

Elimina el grupo con el identificador especificado.

Id. de la operación:: DeleteGroup

Elimina el grupo con el identificador especificado. Esto se realizará correctamente incluso si hay contactos que son miembros del grupo (los contactos no se eliminarán).

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Identificador del grupo	group_id	True	integer	Identificador numérico del grupo que se va a eliminar.

Devoluciones

response: string

Elimina el panel especificado.

Id. de la operación:: DeleteDashboard

Elimina el panel especificado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.

Devoluciones

response: string

Enviar un mensaje al contacto con el número de teléfono especificado

Id. de la operación:: SendMessageByPhoneNumber

Envía un mensaje (iniciando una nueva conversación si el número de teléfono especificado no tiene historial de mensajes).

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Número de teléfono al mensaje	phone_number	True	string	Número de teléfono del contacto al que enviar un mensaje.
Cuerpo del mensaje	body		string	Contenido del mensaje que se va a enviar.
Nombre del remitente	sender_name		string	Nombre del remitente del mensaje. Esto se muestra en la api y la aplicación web TextRequest al recuperar este mensaje.
Dirección URL de devolución de llamada para cuando se actualiza el estado del mensaje	status_callback		string	Dirección URL de la aplicación web que se va a alcanzar con un comando POST cada vez que el estado de este mensaje pasa de no entregado a enviado (o error).
Dirección URL de devolución de llamada para las solicitudes de ubicación si este mensaje incluye uno	location_callback		string	Dirección URL de devolución de llamada de ubicación que se va a alcanzar con un comando POST cuando el usuario accede a y aprueba compartir su ubicación con el remitente. Para incluir el vínculo, agregue [Solicitud de ubicación] al cuerpo del mensaje. Esta devolución de llamada no es necesaria para las solicitudes de ubicación, pero puede ser útil para las API.
Datos adjuntos multimedia mmS para este mensaje	mms_media		array of string	Matriz de datos adjuntos multimedia MMS para este mensaje. Los datos adjuntos deben ser direcciones URL que se obtienen del punto de conexión posterior a /mms (no se incluye en este conector). No se aceptarán vínculos de datos adjuntos externos.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
message_id	message_id	string	Id. del mensaje. Este valor es único para cada mensaje.
body	body	string	Contenido de este mensaje.
message_direction	message_direction	string	Carácter singular, ya sea R o S, que indica si este mensaje se recibió del contacto o se les envió, respectivamente.
response_by_username	response_by_username	string	Nombre de usuario del usuario solicitud de texto que envió por última vez un mensaje a este usuario.
message_timestamp_utc	message_timestamp_utc	string	Marca de tiempo de cuando la solicitud de texto envió o recibió el mensaje.
delivery_status	delivery_status	string	Estado actual de este mensaje. Esto puede ser "send", "delivered", "error" o "send".
delivery_error	delivery_error	string	Error que provocó que este mensaje no se entregue. Si el delivery_status no es "error", este valor será NULL.
mms_media	mms_media	array of string	Lista de direcciones URL que apuntan a los datos adjuntos de este mensaje. Todas las direcciones URL serán direcciones URL generadas por la solicitud de texto.

Enviar un texto de seguimiento que recuerde al usuario que paga el pago especificado

Id. de la operación:: SendPaymentReminder

Envía un aviso al contacto para pagar el pago especificado. El contenido del mensaje se genera automáticamente. Para evitar el correo no deseado, solo se puede enviar un aviso por pago

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Identificador del pago	payment_id	True	integer	Identificador numérico del pago que se va a actualizar.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
payment_id	payment_id	integer	Identificador numérico del pago.
request_date	request_date	string	Marca de tiempo de cuándo se puso en cola el mensaje inicial de este pago para enviarse.
destinatario	recipient	string	Nombre del destinatario del pago. Puede ser null si el contacto no tiene un nombre asociado a su número de teléfono.
descripción	description	string	Descripción del pago. Esto no se muestra al contacto. Solo lo usan los usuarios internos para el contexto sobre los pagos.
customer_phone	customer_phone	string	Número de teléfono del contacto que se envía este pago.
amount_requested	amount_requested	float	Importe en dólares solicitados por este pago.
is_past_due	is_past_due	boolean	Si este pago ha pasado la fecha de solicitud.
reminder_was_sent	reminder_was_sent	boolean	Si ya se ha enviado un aviso de texto para este pago.
transaction_status	transaction_status	string	Estado de la transacción en authvia. Este valor se inicia como Desconocido.
textrequest_payment_status	textrequest_payment_status	string	Estado de la transacción en Solicitud de texto. Esto representa ese estado que se muestra en la página de pagos de la aplicación Solicitud de texto. Se inicia como Enviado.
reference_number	reference_number	string	Identificador definido por el usuario cuando se crean pagos que se pueden usar para encontrar rápidamente los pagos. Los números de referencia no son únicos; muchos pagos pueden tener la misma referencia.

Marcar un pago como pagado

Id. de la operación:: MarkPaymentPaid

Cierra un pago como "pagado". Use este punto de conexión para cuando el pago se pague a través de un medio distinto del portal de solicitudes de pago. Esto cerrará el pago y agregará su importe de pago a sus estadísticas. Este punto de conexión no es necesario para los pagos pagados a través del portal de pagos enviado a través de la solicitud de texto; que marcará automáticamente un pago como pagado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Identificador del pago	payment_id	True	integer	Identificador numérico del pago que se va a actualizar.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
payment_id	payment_id	integer	Identificador numérico del pago.
request_date	request_date	string	Marca de tiempo de cuándo se puso en cola el mensaje inicial de este pago para enviarse.
destinatario	recipient	string	Nombre del destinatario del pago. Puede ser null si el contacto no tiene un nombre asociado a su número de teléfono.
descripción	description	string	Descripción del pago. Esto no se muestra al contacto. Solo lo usan los usuarios internos para el contexto sobre los pagos.
customer_phone	customer_phone	string	Número de teléfono del contacto que se envía este pago.
amount_requested	amount_requested	float	Importe en dólares solicitados por este pago.
is_past_due	is_past_due	boolean	Si este pago ha pasado la fecha de solicitud.
reminder_was_sent	reminder_was_sent	boolean	Si ya se ha enviado un aviso de texto para este pago.
transaction_status	transaction_status	string	Estado de la transacción en authvia. Este valor se inicia como Desconocido.
textrequest_payment_status	textrequest_payment_status	string	Estado de la transacción en Solicitud de texto. Esto representa ese estado que se muestra en la página de pagos de la aplicación Solicitud de texto. Se inicia como Enviado.
reference_number	reference_number	string	Identificador definido por el usuario cuando se crean pagos que se pueden usar para encontrar rápidamente los pagos. Los números de referencia no son únicos; muchos pagos pueden tener la misma referencia.

Obtener información sobre este panel específico

Id. de la operación:: GetDashboard

Devuelve el nombre y el teléfono del panel.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador numérico del panel.
nombre	name	string	Nombre del panel.
phone	phone	string	Número de texto asociado a este panel.

Obtener los mensajes de una conversación por el número de teléfono de un contacto

Id. de la operación:: GetMessagesByContactPhone

Obtenga la conversación entre el panel y el número de teléfono especificados.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Página número que se va a obtener	page	True	integer	Página de entidades que se van a obtener. Al obtener valores, hay un tamaño máximo por página, definido por page_size. Si la página es mayor que la última página, se devolverá una matriz vacía.
Cantidad de cada entidad que se va a obtener por página	page_size	True	integer	Tamaño de cada página que se va a obtener. Al obtener valores, se trata de un tamaño máximo por página, con acceso a las páginas posteriores realizadas por el parámetro page.
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Número de teléfono del contacto para buscar por	phone_number	True	string	Número de teléfono del contacto para el que se van a obtener mensajes.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
página	meta.page	integer	Página de entidades que se han obtenido. La cantidad de entidades de esta página se define mediante page_size.
page_size	meta.page_size	integer	Número de entidades que se han obtenido en esta página.
total_items	meta.total_items	integer	Número de entidades disponibles en la base de datos, independientemente del tamaño o número de página. Para ver las otras páginas, cambie el número de página de la solicitud.
items	items	array of object	Lista de entidades de mensaje que se han obtenido de la solicitud de texto.
message_id	items.message_id	string	Id. del mensaje. Este valor es único para cada mensaje.
body	items.body	string	Contenido de este mensaje.
message_direction	items.message_direction	string	Carácter singular, ya sea R o S, que indica si este mensaje se recibió del contacto o se les envió, respectivamente.
response_by_username	items.response_by_username	string	Nombre de usuario del usuario solicitud de texto que envió por última vez un mensaje a este usuario.
message_timestamp_utc	items.message_timestamp_utc	string	Marca de tiempo de cuando la solicitud de texto envió o recibió el mensaje.
delivery_status	items.delivery_status	string	Estado actual de este mensaje. Esto puede ser "send", "delivered", "error" o "send".
delivery_error	items.delivery_error	string	Error que provocó que este mensaje no se entregue. Si el delivery_status no es "error", este valor será NULL.
mms_media	items.mms_media	array of string	Lista de direcciones URL que apuntan a los datos adjuntos de este mensaje. Todas las direcciones URL serán direcciones URL generadas por la solicitud de texto.

Obtener todos los contactos que coincidan con el criterio de filtrado especificado

Id. de la operación:: GetContacts

Obtiene todos los contactos que coinciden con el criterio de filtrado especificado. Solo se buscará en el panel especificado; no hay ninguna búsqueda de nivel de cuenta para un número disponible.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Número de teléfono del contacto para buscar por	contact_phone_number		string	Número de teléfono por el que se van a filtrar los contactos.
"Hora del último mensaje enviada antes" de la marca de tiempo de búsqueda en hora UTC	last_message_timestamp_before_utc		date-time	Tiempo límite para buscar contactos por el último mensaje enviado o recibido. No se mostrarán contactos que envíen mensajes después de este tiempo.
"Hora del último mensaje enviado después de" marca de tiempo de búsqueda en hora UTC	last_message_timestamp_after_utc		date-time	Tiempo límite para buscar contactos por el último mensaje enviado o recibido. No se mostrará ningún contacto cuyo último mensaje enviado esté antes de esta hora.
Marca de tiempo de búsqueda "Creado antes"	contact_created_before		date-time	Tiempo límite para buscar contactos por cuando se crearon. No se mostrará ningún contacto creado después de este tiempo.
Marca de tiempo de búsqueda "Creado después"	contact_created_after		date-time	Tiempo límite para buscar contactos por cuando se crearon. No se mostrará ningún contacto creado antes de esta hora.
Si se resuelve la conversación del contacto	is_resolved		boolean	Si se buscan contactos cuyas conversaciones se han resuelto.
Indica si el contacto está bloqueado	is_blocked		boolean	Si se deben buscar contactos bloqueados.
Si el contacto está archivado	is_archived		boolean	Si se van a buscar contactos que se han archivado.
Si se suprime el contacto	is_suppressed		boolean	Si se van a buscar contactos que se han suprimido.
Si el contacto ha optado por no participar	has_opted_out		boolean	Si desea buscar contactos que hayan optado por no recibir textos.
Marca de tiempo de búsqueda "Última hora del mensaje enviada antes"	last_message_sent_before		date-time	Tiempo de interrupción de la búsqueda de contactos por el momento en que se envió el último mensaje al cliente. No se mostrarán contactos que envíen mensajes después de este tiempo. Usa la marca de tiempo como hora local. Para filtrar por marca de tiempo en hora UTC, use last_message_sent_before_utc
Marca de tiempo de búsqueda "Hora del último mensaje enviada después"	last_message_sent_after		date-time	Tiempo de interrupción de la búsqueda de contactos por el momento en que se envió el último mensaje al cliente. No se mostrará ningún contacto cuyo último mensaje enviado esté antes de esta hora. Usa la marca de tiempo como hora local. Para filtrar por marca de tiempo en hora UTC, use last_message_sent_after_utc
Marca de tiempo de búsqueda "Hora del último mensaje recibida antes"	last_message_received_before		date-time	Tiempo límite para buscar contactos por el último mensaje recibido del cliente. No se mostrará ningún contacto que haya recibido mensajes después de este tiempo. Usa la marca de tiempo como hora local. Para filtrar por marca de tiempo en hora UTC, use last_message_sent_before_utc
"Hora del último mensaje recibido después de" marca de tiempo de búsqueda	last_message_received_after		date-time	Tiempo límite para buscar contactos por el último mensaje recibido del cliente. No se mostrará ningún contacto cuyo último mensaje enviado esté antes de esta hora. Usa la marca de tiempo como hora local. Para filtrar por marca de tiempo en hora UTC, use last_message_sent_before_utc
Etiquetas de contacto	tags		string	Lista separada por comas de guides que hacen referencia a etiquetas para filtrar contactos por.
Grupos de contactos	groups		string	Lista separada por comas de identificadores enteros que hacen referencia a grupos por los que filtrar los contactos.
Identificador del campo personalizado por el que se va a filtrar	custom_field_id_1		string	Guid que hace referencia al campo personalizado para filtrar contactos por.
Valor del campo personalizado por el que se va a filtrar	custom_field_value_1		string	Valor que hace referencia al campo personalizado para filtrar contactos por.
Identificador del segundo campo personalizado por el que filtrar	custom_field_id_2		string	Guid que hace referencia al segundo campo personalizado para filtrar contactos por.
Valor del segundo campo personalizado por el que se va a filtrar	custom_field_value_2		string	Valor que hace referencia al segundo campo personalizado para filtrar contactos por.
Identificador del tercer campo personalizado por el que se va a filtrar	custom_field_id_3		string	Guid que hace referencia al tercer campo personalizado para filtrar contactos por.
Valor de tercer campo personalizado por el que se va a filtrar	custom_field_value_3		string	Valor que hace referencia al tercer campo personalizado para filtrar contactos por.
Página número que se va a obtener	page	True	integer	Página de entidades que se van a obtener. Al obtener valores, hay un tamaño máximo por página, definido por page_size. Si la página es mayor que la última página, se devolverá una matriz vacía.
Cantidad de cada entidad que se va a obtener por página	page_size	True	integer	Tamaño de cada página que se va a obtener. Al obtener valores, se trata de un tamaño máximo por página, con acceso a las páginas posteriores realizadas por el parámetro page.
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
página	meta.page	integer	Página de entidades que se han obtenido. La cantidad de entidades de esta página se define mediante page_size.
page_size	meta.page_size	integer	Número de entidades que se han obtenido en esta página.
total_items	meta.total_items	integer	Número de entidades disponibles en la base de datos, independientemente del tamaño o número de página. Para ver las otras páginas, cambie el número de página de la solicitud.
items	items	array of object	Lista de entidades de contacto que se han obtenido de la solicitud de texto.
número_de_teléfono	items.phone_number	string	Número de teléfono de este contacto.
first_name	items.first_name	string	Nombre de este contacto.
last_name	items.last_name	string	Apellidos de este contacto.
display_name	items.display_name	string	Nombre completo de este contacto. Este es el nombre predeterminado que se muestra en la aplicación web al ver los contactos.
is_suppressed	items.is_suppressed	boolean	Si se suprime la conversación con este contacto y, por tanto, no se inserta en la parte superior de la cola de mensajes cuando se recibe.
is_archived	items.is_archived	boolean	Si la conversación con este contacto se archiva y, por tanto, no se puede ver al consultar conversaciones (de forma predeterminada).
is_blocked	items.is_blocked	boolean	Indica si la conversación con este contacto está bloqueada y, por tanto, no se recibe ni almacena.
suppressed_reason	items.suppressed_reason	string	Frase que describe el motivo para suprimir el contacto. Si is_suppressed es false, será null.
nota	items.note	string	Frase corta que describe el contacto. Se usa para mayor comodidad. Esto nunca se muestra al contacto.
groups	items.groups	array of integer	Matriz de identificadores enteros a los que hace referencia a los grupos a los que pertenece este contacto.
contact_tags	items.contact_tags	array of string	Matriz de guides que hacen referencia a etiquetas adjuntas a este contacto.
custom_fields	items.custom_fields	array of object	Matriz de identificadores y valores de campo personalizados definidos para este contacto.
id	items.custom_fields.id	string	Guid que hace referencia a un campo personalizado.
value	items.custom_fields.value	string	El valor de este contacto para este campo personalizado.
is_resolved	items.is_resolved	boolean	Si se resuelve la conversación con este contacto. Los nuevos textos recibidos por este contacto establecerán este false.
first_contact_utc	items.first_contact_utc	string	Marca de tiempo de cuándo se envió el primer mensaje a este contacto.
opted_out_utc	items.opted_out_utc	string	Marca de tiempo de cuando este contacto optó por no recibir mensajes.
last_msg_sent_utc	items.last_msg_sent_utc	string	Marca de tiempo de cuándo se envió el último mensaje a este contacto.
last_msg_received_utc	items.last_msg_received_utc	string	Marca de tiempo de cuando se recibió el último mensaje de este contacto.
total_msgs_sent	items.total_msgs_sent	integer	Número de mensajes totales enviados a este contacto.
total_msgs_received	items.total_msgs_received	integer	Número de mensajes totales recibidos de este contacto.
response_count	items.response_count	integer	Número total de mensajes de respuesta del contacto.
date_created_utc	items.date_created_utc	string	Marca de tiempo de cuándo se creó el contacto.
last_contact_date_utc	items.last_contact_date_utc	string	Marca de tiempo de cuándo se envió o recibió el último mensaje de este contacto.
message_id	items.last_message.message_id	string	Id. del mensaje. Este valor es único para cada mensaje.
body	items.last_message.body	string	Contenido de este mensaje.
message_direction	items.last_message.message_direction	string	Carácter singular, ya sea R o S, que indica si este mensaje se recibió del contacto o se les envió, respectivamente.
response_by_username	items.last_message.response_by_username	string	Nombre de usuario del usuario solicitud de texto que envió por última vez un mensaje a este usuario.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Marca de tiempo de cuando la solicitud de texto envió o recibió el mensaje.
delivery_status	items.last_message.delivery_status	string	Estado actual de este mensaje. Esto puede ser "send", "delivered", "error" o "send".
delivery_error	items.last_message.delivery_error	string	Error que provocó que este mensaje no se entregue. Si el delivery_status no es "error", este valor será NULL.
mms_media	items.last_message.mms_media	array of string	Lista de direcciones URL que apuntan a los datos adjuntos de este mensaje. Todas las direcciones URL serán direcciones URL generadas por la solicitud de texto.

Obtener todos los paneles de una cuenta

Id. de la operación:: GetDashboards

Obtiene todos los paneles de una cuenta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Página número que se va a obtener	page		integer	Página de entidades que se van a obtener. Al obtener valores, hay un tamaño máximo por página, definido por page_size. Si la página es mayor que la última página, se devolverá una matriz vacía.
Cantidad de cada entidad que se va a obtener por página	page_size		integer	Tamaño de cada página que se va a obtener. Al obtener valores, se trata de un tamaño máximo por página, con acceso a las páginas posteriores realizadas por el parámetro page.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
página	meta.page	integer	Página de entidades que se han obtenido. La cantidad de entidades de esta página se define mediante page_size.
page_size	meta.page_size	integer	Número de entidades que se han obtenido en esta página.
total_items	meta.total_items	integer	Número de entidades disponibles en la base de datos, independientemente del tamaño o número de página. Para ver las otras páginas, cambie el número de página de la solicitud.
items	items	array of object	Lista de entidades de panel que se han obtenido de la solicitud de texto.
id	items.id	integer	Identificador numérico del panel.
nombre	items.name	string	Nombre del panel.
phone	items.phone	string	Número de texto asociado a este panel.

Obtener un grupo por su identificador

Id. de la operación:: GetGroupById

Obtiene el grupo con el identificador especificado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Identificador del grupo	group_id	True	integer	Identificador numérico del grupo que se va a obtener.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador numérico del grupo.
group_member_count	group_member_count	integer	Número de miembros del grupo.
is_keyword	is_keyword	boolean	Wheter this group is a keyword group. Estos grupos se generan automáticamente cuando un usuario configura una palabra clave. Los contactos se agregan automáticamente cuando se inscriben.
nombre	name	string	Nombre de este grupo.
notas	notes	string	Cualquier nota de este grupo.
last_message_sent_utc	last_message_sent_utc	string	Marca de tiempo de cuándo se envió el último mensaje de grupo para este grupo.

Obtiene el contacto con el número de teléfono especificado.

Id. de la operación:: GetContactByPhoneNumber

Obtiene el contacto con el número de teléfono especificado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Número de teléfono del contacto	phone_number	True	string	Número de teléfono del contacto que se va a obtener.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
número_de_teléfono	phone_number	string	Número de teléfono de este contacto.
first_name	first_name	string	Nombre de este contacto.
last_name	last_name	string	Apellidos de este contacto.
display_name	display_name	string	Nombre completo de este contacto. Este es el nombre predeterminado que se muestra en la aplicación web al ver los contactos.
is_suppressed	is_suppressed	boolean	Si se suprime la conversación con este contacto y, por tanto, no se inserta en la parte superior de la cola de mensajes cuando se recibe.
is_archived	is_archived	boolean	Si la conversación con este contacto se archiva y, por tanto, no se puede ver al consultar conversaciones (de forma predeterminada).
is_blocked	is_blocked	boolean	Indica si la conversación con este contacto está bloqueada y, por tanto, no se recibe ni almacena.
suppressed_reason	suppressed_reason	string	Frase que describe el motivo para suprimir el contacto. Si is_suppressed es false, será null.
nota	note	string	Frase corta que describe el contacto. Se usa para mayor comodidad. Esto nunca se muestra al contacto.
groups	groups	array of integer	Matriz de identificadores enteros a los que hace referencia a los grupos a los que pertenece este contacto.
contact_tags	contact_tags	array of string	Matriz de guides que hacen referencia a etiquetas adjuntas a este contacto.
custom_fields	custom_fields	array of object	Matriz de identificadores y valores de campo personalizados definidos para este contacto.
id	custom_fields.id	string	Guid que hace referencia a un campo personalizado.
value	custom_fields.value	string	El valor de este contacto para este campo personalizado.
is_resolved	is_resolved	boolean	Si se resuelve la conversación con este contacto. Los nuevos textos recibidos por este contacto establecerán este false.
first_contact_utc	first_contact_utc	string	Marca de tiempo de cuándo se envió el primer mensaje a este contacto.
opted_out_utc	opted_out_utc	string	Marca de tiempo de cuando este contacto optó por no recibir mensajes.
last_msg_sent_utc	last_msg_sent_utc	string	Marca de tiempo de cuándo se envió el último mensaje a este contacto.
last_msg_received_utc	last_msg_received_utc	string	Marca de tiempo de cuando se recibió el último mensaje de este contacto.
total_msgs_sent	total_msgs_sent	integer	Número de mensajes totales enviados a este contacto.
total_msgs_received	total_msgs_received	integer	Número de mensajes totales recibidos de este contacto.
response_count	response_count	integer	Número total de mensajes de respuesta del contacto.
date_created_utc	date_created_utc	string	Marca de tiempo de cuándo se creó el contacto.
last_contact_date_utc	last_contact_date_utc	string	Marca de tiempo de cuándo se envió o recibió el último mensaje de este contacto.
message_id	last_message.message_id	string	Id. del mensaje. Este valor es único para cada mensaje.
body	last_message.body	string	Contenido de este mensaje.
message_direction	last_message.message_direction	string	Carácter singular, ya sea R o S, que indica si este mensaje se recibió del contacto o se les envió, respectivamente.
response_by_username	last_message.response_by_username	string	Nombre de usuario del usuario solicitud de texto que envió por última vez un mensaje a este usuario.
message_timestamp_utc	last_message.message_timestamp_utc	string	Marca de tiempo de cuando la solicitud de texto envió o recibió el mensaje.
delivery_status	last_message.delivery_status	string	Estado actual de este mensaje. Esto puede ser "send", "delivered", "error" o "send".
delivery_error	last_message.delivery_error	string	Error que provocó que este mensaje no se entregue. Si el delivery_status no es "error", este valor será NULL.
mms_media	last_message.mms_media	array of string	Lista de direcciones URL que apuntan a los datos adjuntos de este mensaje. Todas las direcciones URL serán direcciones URL generadas por la solicitud de texto.

Obtiene el pago con el identificador especificado.

Id. de la operación:: GetPayment

Obtiene el pago con el identificador especificado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Identificador del pago	payment_id	True	integer	Identificador numérico del pago que se va a obtener.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
payment_id	payment_id	integer	Identificador numérico del pago.
request_date	request_date	string	Marca de tiempo de cuándo se puso en cola el mensaje inicial de este pago para enviarse.
destinatario	recipient	string	Nombre del destinatario del pago. Puede ser null si el contacto no tiene un nombre asociado a su número de teléfono.
descripción	description	string	Descripción del pago. Esto no se muestra al contacto. Solo lo usan los usuarios internos para el contexto sobre los pagos.
customer_phone	customer_phone	string	Número de teléfono del contacto que se envía este pago.
amount_requested	amount_requested	float	Importe en dólares solicitados por este pago.
is_past_due	is_past_due	boolean	Si este pago ha pasado la fecha de solicitud.
reminder_was_sent	reminder_was_sent	boolean	Si ya se ha enviado un aviso de texto para este pago.
transaction_status	transaction_status	string	Estado de la transacción en authvia. Este valor se inicia como Desconocido.
textrequest_payment_status	textrequest_payment_status	string	Estado de la transacción en Solicitud de texto. Esto representa ese estado que se muestra en la página de pagos de la aplicación Solicitud de texto. Se inicia como Enviado.
reference_number	reference_number	string	Identificador definido por el usuario cuando se crean pagos que se pueden usar para encontrar rápidamente los pagos. Los números de referencia no son únicos; muchos pagos pueden tener la misma referencia.

Obtiene todas las conversaciones de este panel.

Id. de la operación:: GetConversations

Obtiene todas las conversaciones de este panel e incluye información sobre el último mensaje de cada conversación.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Etiquetas de contacto	tags		string	Lista separada por comas de guides que hacen referencia a etiquetas para filtrar conversaciones por.
Indica si solo se muestran las conversaciones resueltas	show_unresolved_only		string	Si solo se buscan contactos cuyas conversaciones se han resuelto. Si se trata de false, se mostrarán las conversaciones resueltas y sin resolver.
Si se deben incluir conversaciones archivadas	include_archived		string	Si se deben incluir conversaciones con contactos que se han archivado.
Término para filtrar por números de teléfono y nombre de contacto	search		string	Término de búsqueda para filtrar conversaciones por número de teléfono o nombre para mostrar. Si el término de búsqueda es menor que un nombre completo o un número de teléfono, la búsqueda devolverá todas las conversaciones que coincidan parcialmente.
Página número que se va a obtener	page		integer	Página de entidades que se van a obtener. Al obtener valores, hay un tamaño máximo por página, definido por page_size. Si la página es mayor que la última página, se devolverá una matriz vacía.
Cantidad de cada entidad que se va a obtener por página	page_size		integer	Tamaño de cada página que se va a obtener. Al obtener valores, se trata de un tamaño máximo por página, con acceso a las páginas posteriores realizadas por el parámetro page.
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
página	meta.page	integer	Página de entidades que se han obtenido. La cantidad de entidades de esta página se define mediante page_size.
page_size	meta.page_size	integer	Número de entidades que se han obtenido en esta página.
total_items	meta.total_items	integer	Número de entidades disponibles en la base de datos, independientemente del tamaño o número de página. Para ver las otras páginas, cambie el número de página de la solicitud.
items	items	array of object	Lista de entidades de conversación que se han obtenido de la solicitud de texto.
número_de_teléfono	items.phone_number	string	Número de teléfono del contacto
message_id	items.last_message.message_id	string	Id. del mensaje. Este valor es único para cada mensaje.
body	items.last_message.body	string	Contenido de este mensaje.
message_direction	items.last_message.message_direction	string	Carácter singular, ya sea R o S, que indica si este mensaje se recibió del contacto o se les envió, respectivamente.
response_by_username	items.last_message.response_by_username	string	Nombre de usuario del usuario solicitud de texto que envió por última vez un mensaje a este usuario.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Marca de tiempo de cuando la solicitud de texto envió o recibió el mensaje.
delivery_status	items.last_message.delivery_status	string	Estado actual de este mensaje. Esto puede ser "send", "delivered", "error" o "send".
delivery_error	items.last_message.delivery_error	string	Error que provocó que este mensaje no se entregue. Si el delivery_status no es "error", este valor será NULL.
mms_media	items.last_message.mms_media	array of string	Lista de direcciones URL que apuntan a los datos adjuntos de este mensaje. Todas las direcciones URL serán direcciones URL generadas por la solicitud de texto.

Obtiene todas las etiquetas.

Id. de la operación:: GetTags

Obtiene todas las etiquetas de este panel. Las etiquetas son únicas entre paneles.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.
Página número que se va a obtener	page	True	integer	Página de entidades que se van a obtener. Al obtener valores, hay un tamaño máximo por página, definido por page_size. Si la página es mayor que la última página, se devolverá una matriz vacía.
Cantidad de cada entidad que se va a obtener por página	page_size	True	integer	Tamaño de cada página que se va a obtener. Al obtener valores, se trata de un tamaño máximo por página, con acceso a las páginas posteriores realizadas por el parámetro page.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
página	meta.page	integer	Página de entidades que se han obtenido. La cantidad de entidades de esta página se define mediante page_size.
page_size	meta.page_size	integer	Número de entidades que se han obtenido en esta página.
total_items	meta.total_items	integer	Número de entidades disponibles en la base de datos, independientemente del tamaño o número de página. Para ver las otras páginas, cambie el número de página de la solicitud.
items	items	array of object	Lista de entidades de etiqueta que se han obtenido de la solicitud de texto.
id	items.id	string	Identificador numérico de la etiqueta.
tag_color	items.tag_color	string	Color de la etiqueta. Debe ser un código de color hexadecimal válido.
tag	items.tag	string	Nombre de la etiqueta.

Obtiene todos los campos personalizados.

Id. de la operación:: GetCustomFields

Obtiene todos los campos personalizados de este panel. Los campos personalizados son únicos entre paneles.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
		array of object
id	id	string	Identificador numérico del campo.
nombre	name	string	Nombre del campo personalizado.

Obtiene todos los grupos.

Id. de la operación:: GetGroups

Obtiene todos los grupos de la cuenta del usuario.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Página número que se va a obtener	page	True	integer	Página de entidades que se van a obtener. Al obtener valores, hay un tamaño máximo por página, definido por page_size. Si la página es mayor que la última página, se devolverá una matriz vacía.
Cantidad de cada entidad que se va a obtener por página	page_size	True	integer	Tamaño de cada página que se va a obtener. Al obtener valores, se trata de un tamaño máximo por página, con acceso a las páginas posteriores realizadas por el parámetro page.
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
página	meta.page	integer	Página de entidades que se han obtenido. La cantidad de entidades de esta página se define mediante page_size.
page_size	meta.page_size	integer	Número de entidades que se han obtenido en esta página.
total_items	meta.total_items	integer	Número de entidades disponibles en la base de datos, independientemente del tamaño o número de página. Para ver las otras páginas, cambie el número de página de la solicitud.
items	items	array of object	Lista de entidades de grupo que se han obtenido de la solicitud de texto.
id	items.id	integer	Identificador numérico del grupo.
group_member_count	items.group_member_count	integer	Número de miembros del grupo.
is_keyword	items.is_keyword	boolean	Wheter this group is a keyword group. Estos grupos se generan automáticamente cuando un usuario configura una palabra clave. Los contactos se agregan automáticamente cuando se inscriben.
nombre	items.name	string	Nombre de este grupo.
notas	items.notes	string	Cualquier nota de este grupo.
last_message_sent_utc	items.last_message_sent_utc	string	Marca de tiempo de cuándo se envió el último mensaje de grupo para este grupo.

Obtiene todos los pagos

Id. de la operación:: GetPayments

Obtiene todos los pagos, incluidos los pagos cancelados y pagados. Estos se pueden filtrar mediante los parámetros de consulta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Cadena de referencia del pago	reference_number		string	Identificador definido por el usuario cuando se crean pagos que se pueden usar para encontrar rápidamente pagos. Los números de referencia no son únicos; muchos pagos pueden tener la misma referencia.
Número de teléfono de pago	phone_number		string	Número de teléfono del contacto al que se envió este pago.
Ordenar por	sort_type		string	Propiedad para ordenar pagos por. Puede ser "amount", "contact", "date", "status".
Dirección de ordenación	sort_direction		string	Dirección en la que se ordenan los pagos. Puede ser "desc" para mayor a menor o "asc" para menor a mayor.
Página número que se va a obtener	page	True	integer	Página de entidades que se van a obtener. Al obtener valores, hay un tamaño máximo por página, definido por page_size. Si la página es mayor que la última página, se devolverá una matriz vacía.
Cantidad de cada entidad que se va a obtener por página	page_size	True	integer	Tamaño de cada página que se va a obtener. Al obtener valores, se trata de un tamaño máximo por página, con acceso a las páginas posteriores realizadas por el parámetro page.
Identificador del panel en el que realizar esta llamada	dashboard_id	True	integer	Panel de número de teléfono en el que trabajar. Una sola cuenta puede tener varios paneles, que representan diferentes líneas de teléfono para los clientes.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
página	meta.page	integer	Página de entidades que se han obtenido. La cantidad de entidades de esta página se define mediante page_size.
page_size	meta.page_size	integer	Número de entidades que se han obtenido en esta página.
total_items	meta.total_items	integer	Número de entidades disponibles en la base de datos, independientemente del tamaño o número de página. Para ver las otras páginas, cambie el número de página de la solicitud.
items	items	array of object	Lista de entidades de pago que se han obtenido de la solicitud de texto.
payment_id	items.payment_id	integer	Identificador numérico del pago.
request_date	items.request_date	string	Marca de tiempo de cuándo se puso en cola el mensaje inicial de este pago para enviarse.
destinatario	items.recipient	string	Nombre del destinatario del pago. Puede ser null si el contacto no tiene un nombre asociado a su número de teléfono.
descripción	items.description	string	Descripción del pago. Esto no se muestra al contacto. Solo lo usan los usuarios internos para el contexto sobre los pagos.
customer_phone	items.customer_phone	string	Número de teléfono del contacto que se envía este pago.
amount_requested	items.amount_requested	float	Importe en dólares solicitados por este pago.
is_past_due	items.is_past_due	boolean	Si este pago ha pasado la fecha de solicitud.
reminder_was_sent	items.reminder_was_sent	boolean	Si ya se ha enviado un aviso de texto para este pago.
transaction_status	items.transaction_status	string	Estado de la transacción en authvia. Este valor se inicia como Desconocido.
textrequest_payment_status	items.textrequest_payment_status	string	Estado de la transacción en Solicitud de texto. Esto representa ese estado que se muestra en la página de pagos de la aplicación Solicitud de texto. Se inicia como Enviado.
reference_number	items.reference_number	string	Identificador definido por el usuario cuando se crean pagos que se pueden usar para encontrar rápidamente los pagos. Los números de referencia no son únicos; muchos pagos pueden tener la misma referencia.

Desencadenadores

Desencadena cuando se envía o recibe un texto

Id. de la operación:: TextingWebhook

Desencadena cuando se envía o recibe un texto

Parámetros

Nombre	Clave	Requerido	Tipo	Description
El panel del desencadenador escuchará eventos desde	dashboard_id	True	string	Identificador del panel al que agregar el desencadenador
evento	event	True	string	evento

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Id. único del mensaje	messageUniqueIdentifier	string	messageUniqueIdentifier
ID de cuenta	account.id	integer	id
Id. de conversación	yourPhoneNumber.id	integer	id
Nombre del panel	yourPhoneNumber.description	string	descripción
Número de teléfono del panel	yourPhoneNumber.phoneNumber	string	número de teléfono
Id. del panel	conversation.id	integer	id
date	conversation.date	string	date
Número de teléfono de contacto	conversation.consumerPhoneNumber	string	consumerPhoneNumber
messageDirection	conversation.messageDirection	string	messageDirection
Mensaje	conversation.message	string	Mensaje
numSegments	conversation.numSegments	integer	numSegments
estado	conversation.status	string	estado
Conversación reclamada por	conversation.claimedBy	string	claimedBy
Nombre para mostrar del contacto	conversation.consumerFriendlyName	string	consumerFriendlyName

Definiciones

cuerda / cadena

Este es el tipo de datos básico "string".

Compartir a través de

Solicitud de texto

Aranda Service Management Suite (ASMS)

Requisitos previos

Obtención de credenciales

Introducción al conector

Respuesta exitosa

Errores y soluciones comunes

Preguntas más frecuentes

Creación de una conexión

Predeterminado

Limitaciones

Acciones

Actualiza un grupo con el identificador especificado.

Parámetros

Devoluciones

Actualizar el nombre de un panel específico

Parámetros

Devoluciones

Archivar una conversación

Parámetros

Devoluciones

Cancela el pago especificado.

Parámetros

Devoluciones

Contactos de actualización masiva

Parámetros

Devoluciones

Crea un nuevo grupo

Parámetros

Devoluciones

Crea un nuevo pago

Parámetros

Devoluciones

Crear o actualizar un contacto

Parámetros

Devoluciones

Crear un nuevo panel con el nombre y el número de teléfono especificados

Parámetros

Devoluciones

Desarchivar una conversación

Parámetros

Devoluciones

Elimina el contacto con el número de teléfono especificado.

Parámetros

Devoluciones

Elimina el grupo con el identificador especificado.

Parámetros

Devoluciones

Elimina el panel especificado.

Parámetros

Devoluciones

Enviar un mensaje al contacto con el número de teléfono especificado

Parámetros

Devoluciones

Enviar un texto de seguimiento que recuerde al usuario que paga el pago especificado

Parámetros

Devoluciones

Marcar un pago como pagado

Parámetros

Devoluciones

Obtener información sobre este panel específico

Parámetros

Devoluciones

Obtener los mensajes de una conversación por el número de teléfono de un contacto

Parámetros

Devoluciones

Obtener todos los contactos que coincidan con el criterio de filtrado especificado

Parámetros

Devoluciones

Obtener todos los paneles de una cuenta

Parámetros

Devoluciones

Obtener un grupo por su identificador

Parámetros

Devoluciones

Obtiene el contacto con el número de teléfono especificado.

Parámetros

Devoluciones

Obtiene el pago con el identificador especificado.