Omni-Channel Messaging
Documentation /

Chatbot Connector Services

 

The service allows Syniverse Cloud messaging customer to leverage SCG (Syniverse Communication Gateway) message delivery channels and provide connectivity to external entities which expose messaging APIs and for which this service has a corresponding API module (or plugin) in place.

Syniverse Connector Service

The Syniverse Connector service provides Customers Chatbot Service accounts hosted on Cloud platforms a dedicated connector that allows them to create and enable a Syniverse messaging channel for their Bot services to communicate with their end-users.

The service will provide REST endpoint “connectors” where the user will be able to do CRUD operations for its connectors. The connector entity will contain configuration information needed for the corresponding service to function.

 

SCG_CONNECT_DEFAULT_CONVERSATION_IDLE_TIMEOUT (2 * 60)

After this time with no MO the conversation will be considered finished and will be closed. Subsequent message from the same user will open a new conversation.

Connector Service Integration

Connector service is now available for the following services:

  • MS Azure Cloud Connector

The connector service is able to translate session-oriented APIs like the Direct Link into paging-oriented APIs by emulating session behavior based on a Syniverse Sender ID, end-user contact (MDN) and time.

The service can also be used with a wide range of Syniverse Messaging Channels that are IP-based but also can be used on SMS services. The connector service supports text-based conversation with the channels listed below. Images and rich media payloads are currently not supported.

Syniverse Messaging Channels for Connectors

The Syniverse Messaging channels that can be leveraged on the Syniverse connector service include:

  • SMS
  • WhatsApp

Prerequisite to using the Syniverse Connector service

  • Syniverse Cloud Messaging Account with a subscription to Voice and Messaging service (https://developer.syniverse.com )
  • A valid Dedicated Sender ID (Can be a Shortcode, Longcode, or toll-free number. Can also be a Sender ID configured for WhatsApp, RCS, WeChat or Facebook Messenger).

The service will consist of two major parts - SCG MO Handler and API MT Handler.

 

Creating a Connector service in SCG

Creating a MS Azure Chatbot Connector

 

In order to create the connector an active private SenderID  is needed. Once the senderId is available use following curl to create the connector:

curl -X POST  https://api.syniverse.com/scg-external-api/api/v1/connect/connectors H 'Content-Type: application/json' -H "Authorization: Bearer {Token}" 

-d '{"type":"AZURE_BOT_DIRECT_LINE","sender_id":"Uu4txaiKbAWjMN8427QEM2","credentials":"ZrVkDm7_F24.cwA.BEs.Sz0w9A3HT1jhIo67glktyW4wz73y6J_Hd810FP6eFTpQ","external_id":"Test123"}'

Where:

  • BOT type: AZURE_BOT_DIRECT_LINE
  • Sender ID: Uu4txaiKbAWjMN8427QEM2 (SMS-Capable Sender ID)
  • Credentials: Your MS Azure Bot Secret Key
  • External ID: Optional unique identifier

Response

You will receive a <ConnectorID> as response to a successful request.

Interacting with your Bot

  • Send a MO (Mobile Originated) message to your Sender Address which will be passed to your BOT
  • If your BOT responds, the messages will be delivered to the Mobile device

Other activities you can invoke on the connector service

  • List a Connector
curl -X GET https://api.syniverse.com/scg-external-api/api/v1/connect/connectors/<ConnectorID> -H "Authorization: Bearer {Token}"
  • List all your Connectors
curl -X GET https://api.syniverse.com/scg-external-api/api/v1/connect/connectors -H "Authorization: Bearer {Token}"
  • Update a Connector
curl -X POST https://api.syniverse.com/scg-external-api/api/v1/connect/connectors/<ConnectorID> -H 'Content-Type: application/json' -H "Authorization: Bearer {Token}" -d '{"sender_id":"my-updated-sender-id","credentials":"update-credentials","external_id":"changed-id-assigned-by-me","version_number":"1"}
  • Delete a connector
curl -X DELETE https://api.syniverse.com/scg-external-api/api/v1/connect/connectors/<ConnectorID> -H "Authorization: Bearer {Token}"

For more information on the API endpoints for the Connector service, please visit our API reference page on the Developer community portal

FAQ

 

  • Q: How many messages per sec can the service support?
  • A: Default throughput for a connector service is 30 MPs.

 

  • Q: Can I configure multiple sender IDs for my BOT service?
  • A: Yes, however a Sender ID can only be assigned to 1 Connector

 

  • Q: How many connectors can I create
  • A: You can create as many connectors as you want. However, please note that each connector can only have one unique Sender ID

 

 

For more information on how to get started with SCG connector service, please contact your account representative.

Copyright © 2023 Syniverse Technologies