Suggestions

close search

Call settings

View call settings

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

HTTP method: GET

Content-Type: application/json

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

Response:

{
    "r": 0,
    "message": "Load call settings success",
    "callSetting": {
        "account": 2,
        "project": 2,
        "get_customer_info_url": "http://sample.com/get_customer_info_url",
        "get_customer_info_timeout": 300,
        "event_url": "http://sample.com/event_url",
        "callout_answer_url": "http://sample.com/callout_answer_url"
    }
}

Field	Type	Require	Default	Description
r	Int	Yes		Result code
project	Int	Yes		Your project ID
get_customer_info_url	String	Yes	NULL	Stringee sends a GET request to this URL to get customer's info. When the client receives an incoming call, this info will be passed to the customDataFromYourServer field of the StringeeCall instance.
get_customer_info_timeout	Int	Yes	2000	The timeout (in milliseconds) that Stringee will wait for the result of the GET request sent to get_customer_info_url.
event_url	String	Yes	NULL	Stringee sends calls' events to this URL (on Your Server). These events will help you store call logs, make call reports... See Call Events
callout_answer_url	String	Yes	NULL

get_customer_info_url GET parameters:

Field	Type	Require	Description
from	String	Yes	From number (customer number)
to	String	Yes	To number
project	Int	Yes	Your project ID

Update call settings

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

HTTP method: PUT

Content-Type: application/json

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

PUT data (body):

{
    "get_customer_info_url": "URL",
    "get_customer_info_timeout": 90,
    "event_url": "URL",
    "callout_answer_url": "ANSWER_URL"
}

Response:

{
    "r": 0,
    "message": "Update call settings success",
    "project": 2
}