IVR node keypress management

Add a keypress to an IVR node

URL: https://icc-api.stringee.com/v1/ivrkeypress

HTTP method: POST

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Authentication

POST data (body):

{
    "node": "IVR_NODE_ID",
    "node_key": "DTMF_KEY",
    "action": ACTION_TYPE,

    "next_node": "NEXT_IVR_NODE_ID",
    "queue_id": "QUEUE_ID",

    "from_number_callout_to_agent": "STRINGEE_FROM_NUMBER",
    "to_phone_number": "TO_PHONE_NUMBER",

    "sms": "SMS_CONTENT",
}

Field	Type	Require	Description
node	String	YES	The IVR Node ID
node_key	String	YES	Presskey: 0-9, *, # EMPTY_KEY: when timeout INVALID_KEY: invalid key
action	Int	YES	Actions when the caller presses a key: 1=Go to voice mail (Coming soon); 2=Route to a queue; 3=Forward to a phone number; 4=Go to the next IVR node; 5=Send an SMS to the caller (Coming soon); 6=Stop call
next_node	String	NO	The next IVR node ID when action=4
queue_id	String	NO	The queue ID to route the caller to when action=2
from_number_callout_to_agent	String	NO	The from phone number when callout to agent's phone number (when action=3)
to_phone_number	String	NO	The phone number to forward the call to when action=3
sms	String	NO	(Coming soon) The SMS content sent to the caller when action=5

Response:

{
    "r": 0,
    "project": 246,
    "ivrNodeKeyID": "NO_KE_F0BSI4Q82DDWS9RM",
    "message": "Create ivr node key success"
}

Field	Type	Require	Description
r	Int	Yes	Result code
project	Int	Yes	Your project ID
message	String	No	Result message
ivrNodeKeyID	String	No	The IVR node key ID

Sample request

POST /v1/ivrkeypress HTTP/1.1
Host: https://icc-api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

{
    "node": "99OL694QXB2PJJLW",
    "node_key": "1",
    "action": 4,
    "next_node": "G4Z7KTUI3L8MFXA6"
}

Sample response

{
    "r": 0,
    "project": 246,
    "ivrNodeKeyID": "5JQHIG78VPI3MBAM",
    "message": "Create ivr node key success"
}

Keypress list of an IVR node

URL: https://icc-api.stringee.com/v1/ivrkeypress?node={NODE_ID}

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Authentication

GET parameters:

Field	Type	Require	Description
node	String	YES	The IVR node ID

Response:

{
    "r": 0,
    "message": "Load IVR node key success",
    "project": 246,
    "data": {
        "totalCount": "1",
        "totalPages": 1,
        "currentPage": 1,
        "limit": 50,
        "ivrNodeKeys": [
            {
                "id": "NO_KE_F0BSI4Q82DDWS9RM",
                "account": 408,
                "project": 246,
                "tree": "TR_3L00Y4W0COG0S3NW",
                "node": "NO_294UFJIAVSI91WID",
                "node_key": "DTMF_KEY",
                "action": 4,
                "next_node": "NO_294UFJIAVSI91WID",
                "queue_id": null,
                "to_phone_number": null,
                "sms": null
            }
        ]
    }
}

Field	Type	Require	Description
r	Int	Yes	Result code
project	Int	Yes	Your project ID
message	String	Yes	Result message
data	JSON	Yes	The key press list

Sample request

GET /v1/ivrkeypress?node=NO_294UFJIAVSI91WID HTTP/1.1
Host: https://icc-api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

Sample response

{
    "r": 0,
    "message": "Load IVR node key success",
    "project": 246,
    "data": {
        "totalCount": "1",
        "totalPages": 1,
        "currentPage": 1,
        "limit": 50,
        "ivrNodeKeys": [
            {
                "id": 17,
                "account": 408,
                "project": 246,
                "tree": 7,
                "node": 10,
                "node_key": "1",
                "action": 4,
                "next_node": 10,
                "queue_id": 0,
                "to_phone_number": null,
                "sms": null
            }
        ]
    }
}

Delete a keypress of an IVR node

URL: https://icc-api.stringee.com/v1/ivrkeypress/{IVR_NODE_KEY_ID}

HTTP method: DELETE

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Authentication

URI Parameters:

Field	Type	Require	Description
{IVR_NODE_KEY_ID}	String	Yes	The IVR node key ID

Response:

{
    "r": RESULT_CODE,
    "project": YOUR_PROJECT_ID,
    "message": "RESULT_MESSAGE"
}

Field	Type	Require	Description
r	Int	Yes	Result code
project	Int	Yes	Your project ID
message	String	No	Result message

Sample request

DELETE /v1/ivrkeypress/NO_294UFJIAVSI91WID HTTP/1.1
Host: https://icc-api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

Sample response

{
    "r": 0,
    "project": 246,
    "message": "Delete ivr node key success"
}

Update IVR node keypress

URL: https://icc-api.stringee.com/v1/ivrkeypress/{IVR_NODE_KEYPRESS_ID}

HTTP method: PUT

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see Authentication

PUT data (body):

{
    "node_key": "DTMF_KEY",
    "action": ACTION,
    "next_node": "NEXT_IVR_NODE_ID",
    "queue_id": "QUEUE_ID",

    "from_number_callout_to_agent": "STRINGEE_FROM_NUMBER",
    "to_phone_number": "TO_PHONE_NUMBER",

    "sms": "SMS_CONTENT"
}

Field	Type	Require	Description
node_key	String	No	Presskey: 0-9, *, # EMPTY_KEY: when timeout INVALID_KEY: invalid key
action	Int	No	Actions when the caller presses a key: 1=Go to voice mail; 2=Route to a queue; 3=Forward to a phone number; 4=Go to the next IVR node; 5=Send an SMS to the caller; 6=Stop call
next_node	String	No	The next IVR node ID when action=4
queue_id	String	No	The queue ID to route the caller to when action=2
from_number_callout_to_agent	String	No	The from phone number when callout to agent's phone number (when action=3)
to_phone_number	String	No	The phone number to forward the call to when action=3
sms	String	No	The SMS content sent to the caller when action=5

URI Parameters:

Field	Type	Require	Description
{IVR_NODE_KEYPRESS_ID}	String	Yes	The IVR Node Keypress ID

Response:

{
    "r": RESULT_CODE,
    "project": YOUR_PROJECT_ID,
    "ivrNodeKeyID": "YOUR_IVR_KEYPRESS_ID",
    "message": "RESULT_MESSAGE"
}

Field	Type	Require	Description
r	Int	Yes	Result code
project	Int	No	Your project ID
message	String	Yes	Result message
ivrNodeKeyID	String	No	The IVR Node Keypress ID if update successfully

Sample request

PUT /v1/ivrkeypress/NO_KE_5I4IWGSO7L5CXGR5 HTTP/1.1
Host: https://icc-api.stringee.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

{
    "node_key": "5",
    "action": 2,
    "queue_id": "QU_JFYXLG3RXZBFCTZY"
}

Sample response

{
    "r": 0,
    "project": 2,
    "ivrNodeKeyID": "NO_KE_5I4IWGSO7L5CXGR5",
    "message": "Update ivr node key success"
}

Suggestions

IVR node keypress management

Add a keypress to an IVR node

Keypress list of an IVR node

Delete a keypress of an IVR node

Update IVR node keypress