...
Attempts to transfer the original call party to the consult call party. If successful, both conversations will end for this agent and the two parties will be connected together. A failure is generated if a consult call is not connected or the call cannot be transferred.
Request
{
| Code Block | ||
|---|---|---|
| ||
{ "command": "interaction.consulttransfer", |
...
"target": "<session-id>.<channel-id>.<interaction-id>" | "<session-id>.<channel-group-id>.<channel-id>.<interaction-id>", |
...
"data": {} |
...
} |
Success Response
| Code Block |
|---|
{
| ||
{ "command": "interaction.consulttransfer", |
...
"target": "<session-id>.<channel-id>.<interaction-id>" | "<session-id>.<channel-group-id>.<channel-id>.<interaction-id>", |
...
"result": "success", |
...
"data": |
...
{
<Same data contents as original request>
}
{ <Same data contents as original request> } } |
Failure Response
{
| Code Block | ||
|---|---|---|
| ||
{ "command": "interaction.consulttransfer", |
...
"target": "<session-id>.<channel-id>.<interaction-id>" | "<session-id>.<channel-group-id>.<channel-id>.<interaction-id>", |
...
"result": "failure", |
...
"failure": |
...
{
{ "code": "<error-code-for-failure>", |
...
"message": "<error-message>", |
...
"context": "<stack-trace-if-applicable>" |
...
}
}, "original": |
...
<Contains the original request JSON structure>
{ <Contains the original request JSON structure> } } |
Secondary Events
Performing a consult transfer will generate the following secondary events:·
state.updated (conversation state event, original call)
...
conversation.disposed (original call)
...
interaction.focuschanged
...
state.updated (conversation state event, consult call)
...
conversation.disposed (consult call)
...
interaction.ended
interaction.consultconference (Telephony only)
Attempts to conference the consult call party into the original call. If successful, both parties will be in conference together. A failure is generated if a consult call is not connected or the call cannot be conferenced.
Request
{
| Code Block | ||
|---|---|---|
| ||
{ "command": "interaction.consultconference", |
...
"target": "<session-id>.<channel-id>.<interaction-id>" | "<session-id>.<channel-group-id>.<channel-id>.<interaction-id>", |
...
"data": {} |
...
} |
Success Response
| Code Block |
|---|
{
| ||
{ "command": "interaction.consultconference", |
...
"target": "<session-id>.<channel-id>.<interaction-id>" | "<session-id>.<channel-group-id>.<channel-id>.<interaction-id>", |
...
"result": "success", |
...
"data": |
...
{
<Same data contents as original request>
}
{ <Same data contents as original request> } } |
Failure Response
| Code Block |
|---|
{
| ||
{ "command": "interaction.consultconference", |
...
"target": "<session-id>.<channel-id>.<interaction-id>" | "<session-id>.<channel-group-id>.<channel-id>.<interaction-id>", |
...
"result": "failure", |
...
"failure": |
...
{
{ "code": "<error-code-for-failure>", |
...
"message": "<error-message>", |
...
"context": "<stack-trace-if-applicable>" |
...
}
}, "original": |
...
<Contains the original request JSON structure>
{ <Contains the original request JSON structure> } } |
Secondary Events
Performing a consult conference will generate the following secondary events:·
state.updated (conversation state event, consult call)
...
conversation.disposed (consult call)
...
conversation.memeber.added (original call, consult party)
...
state.updated (conversation state event, original call)
...
interaction.focuschanged
interaction.request.recording.start (Telephony only)
Attempts to start call recording. If recording is already underway, this should successfully return.
Request
{
.
Request
| Code Block | ||
|---|---|---|
| ||
{ "command": "interaction.request.recording.start", |
...
"target": "<session-id>.<channel-id>.<interaction-id>" | "<session-id>.<channel-group-id>.<channel-id>.<interaction-id>", |
...
"data": {} |
...
} |
Success Response
| Code Block | ||
|---|---|---|
| ||
{ |
...
"command": " interaction.request.recording.start", |
...
"target": "<session-id>.<channel-id>.<interaction-id>" | "<session-id>.<channel-group-id>.<channel-id>.<interaction-id>", |
...
"result": "success", |
...
"data": |
...
{
<Same data contents as original request>
}
{ <Same data contents as original request> } } |
Failure Response
| Code Block | ||
|---|---|---|
| ||
{ |
...
"command": " interaction.request.recording.start", |
...
"target": "<session-id>.<channel-id>.<interaction-id>" | "<session-id>.<channel-group-id>.<channel-id>.<interaction-id>", |
...
"result": "failure", |
...
"failure": |
...
{
{ "code": "<error-code-for-failure>", |
...
"message": "<error-message>", |
...
"context": "<stack-trace-if-applicable>" |
...
}
}, "original": |
...
<Contains the original request JSON structure>
{ <Contains the original request JSON structure> } } |
Secondary Events
Performing start recording will generate the following secondary events:·
state.updated (interaction state event)
interaction.request.recording.stop (Telephony only)
...