Agent Call Status callback

Note

This callback is used for the Audio Caller feature. For more information on the Audio Caller feature, refer to Audio Caller.

The Agent Call Status callback is always invoked when a successful response is received from the agent call API request. This callback delivers whether the initiation of agent call was successful (whether the WAITANSWER event occurred).

For call events after WAITANSWER, such as the callee accepting the call or rejecting the call, refer to 1-to-1 Call Event Callback with the sid value.

Method and endpoint

• Method: GET
• Endpoint: ${agent_call_status_cb_url}

Tip

The Agent Call Status callback URL can be registered in Project > Configuration > Callback URL in the LINE Planet Console. For more information, refer to Callback URL in the LINE Planet Console guide.

Query parameters

Key	Type	Nullable	Description	Example
sid	String	N	Session ID. You can identify a call using an sid. Fixed 36 bytes size without null.	6364e8b3-bdac-436e-9631-0bce2498ce0c
agent_type	String	N	Agent Type AUDIO_CALLER	AUDIO_CALLER
media_source_type	String	N	The media type of the agent call STORED_SOURCE	STORED_SOURCE
result	String	N	Result of making an agent call SUCCESS FAIL	SUCCESS
fail_reason	String	N	Reason for a failure (If successful, None)	Invalid peerId

Example

# Let's suppose agent_call_status_cb_url is
# http://sample.server.com:20200/audio_caller_event
# LINE Planet server will send a request to agent_call_status_cb_url as follows.

GET http://sample.server.com:20200/audio_caller_event?
sid=6364e8b3-bdac-436e-9631-0bce2498ce0c&
agent_type=AUDIO_CALLER&
media_source_type=STORED_SOURCE&
result=Success&
fail_reason=None