Ivr Integration

Instaply makes it very easy for your organization to integrate our texting software into your existing infrastructure.

While each integration can be a bit unique, here is a basic overview of how the IVR integration work:

Instaply​ ​IVR​ ​integration​ ​documentation

Your organization will need to modify your IVR code to call the Instaply API. Once the IVR is pointed to the Instaply API, this will trigger the sending of a welcome SMS message to the caller.

The following API endpoint should be called using the GET HTTP Method:

https://hooks.instaply.com/v1/ivr?key=[ORG_KEY]&from=[CUSTOMER_PHONE]&to=[BUSINESS_PHONE]&context=[CONTEXT] Where:

● ORG_KEY: the key we provided you for your customer organization (ask us when you need a new key)

● CUSTOMER_PHONE: the caller phone number (E.164 format)

● BUSINESS_PHONE: the provided business phone number on Instaply (E.164 format)

● CONTEXT (optional): A value to trigger different welcome SMS depending on the context (see below). If context is not defined a default defined welcome SMS will be sent

API call example:

https://hooks.instaply.com/v1/ivr?key=a73d5034210f702515128ac61193cd21&from=%2B14151234560&to=%2B14151234567&context=OPT_IN

POST​ ​HTTP​ ​method​ ​is​ ​also​ ​available:

Inside the body you need to provide JSON with following fields:

{"key":”[ORG_KEY]”,"from":"[CUSTOMER_PHONE]","to":"[BUSINESS_PHONE]"}

Example

curl -XPOST "https://hooks.instaply.com/v1/ivr' \
-H 'Content-Type: application/json' -d'
{
    "key": "[ORG_KEY",
    "from": "[CUSTOMER_PHONE]",
    "to": "[BUSINESS_PHONE]" 
}
'

TCPA​ ​Compliance:

We always have to keep in mind that the organization must have the express consent of the caller before sending a SMS. Our solution to obtaining consent, is to prompt the caller to input their mobile number, to trigger the SMS.