DocsICP FilingConsole
官方文档
首页

LaunchAuthentication

更新时间：
复制 MD 格式
产品详情
我的收藏

You can invoke LaunchAuthentication to temporarily transfer a call into a specified IVR flow. After invoking this API, the call enters an IVR interaction phase, which is commonly used for identity verification operations.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example
InstanceId

string

Yes

Instance ID.

ccc-test
UserId

string

No

The agent ID that initiates identity verification.

agent@ccc-test
DeviceId

string

No

Device ID. This parameter is meaningless and can be filled in with any value.

ACC-YUNBS-1.0.10-****
JobId

string

Yes

The call ID.

job-6538214103685****
ContactFlowId

string

Yes

The contact flow ID for the IVR identity verification flow.

af145gfc-1108-4d55-8fca-f719bd512ebb
ContactFlowVariables

string

No

Variables passed to the contact flow. This parameter is optional. The configured variables can be retrieved and used within the IVR flow. The format is a JSON string representing a collection of key-value pairs.

{ "customerID": "208880281831****", "operateType": "cipherCode", "taskId": "1234567890", "crmOther": "123" }

Response elements

Element

Type

Description

Example

object

Code

string

Response code.

OK
HttpStatusCode

integer

HTTP status code.

200
Message

string

Response message.

无
RequestId

string

Request ID.

EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Params

array

List of response parameters.

string

Response parameter.

无
Data

object

Data.

CallContext

object

Call context environment.

CallType

string

Call type.

Valid values:

  • INBOUND :

    Inbound

  • BARGE :

    Barge-in

  • CONSULTANT :

    Consultation

  • CONFERENCE :

    Conference

  • MONITOR :

    Listener

  • INTERNAL :

    Internal Call

  • OUTBOUND :

    Outbound

  • INTERCEPT :

    Intercept

  • BACK2BACK :

    Back-to-Back Call

  • PREDICTIVE :

    Predictive Outbound

  • COACH :

    Coaching

OUTBOUND
InstanceId

string

Instance ID.

ccc-test
JobId

string

Call ID.

job-6538214103685****
ChannelContexts

array<object>

List of call channels.

object

Call channel.

Index

integer

An auto-increment ID assigned by the System. Customers do not need to concern themselves with this value.

10
ReleaseInitiator

string

The party that initiated the release of the call channel, indicating who first hung up the call.

1390501****
ChannelState

string

The status of the call channel.

Valid values:

  • CREATED :

    Created

  • ANSWERED :

    Answered

  • RELEASED :

    Released

  • RETIRED :

    Out Of Effect

  • EARLY_MEDIA :

    Early Media

  • NONE :

    Initial Status

  • RINGING :

    Ringing

ANSWERED
Destination

string

Called party of the call channel.

1390501****
UserId

string

The agent ID associated with the channel. This field is empty if the channel belongs to a Customer.

agent@ccc-test
ChannelFlags

string

Channel flags.

Valid values:

  • COACHING :

    Coaching

  • MONITORING :

    Monitoring

  • MONITORED :

    Monitored

  • COACHED :

    Coached

  • HOLD :

    Hold

  • MUTED :

    Muted

MONITORING
SkillGroupId

string

The skill group ID associated with the voice channel. In inbound scenarios, the associated skill group ID is determined by the skill group configured in the IVR transfer-to-agent module. In outbound scenarios, the associated skill group ID is the first skill group that the agent signed into.

skillgroup@ccc-test
Timestamp

integer

The UNIX timestamp of the most recent status change of the voice channel, in milliseconds.

1609138903315
ReleaseReason

string

The hang-up reason for the voice channel, indicating why the current voice channel was disconnected. The value comes from the response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the hang-up reason.

404 - No destination
CallType

string

The call type of the channel.

Valid values:

  • INBOUND :

    Inbound

  • BARGE :

    Barge

  • CONSULTANT :

    Consultation

  • CONFERENCE :

    Conference

  • MONITOR :

    Listener

  • INTERNAL :

    Internal Call

  • OUTBOUND :

    Outbound

  • INTERCEPT :

    Intercept

  • BACK2BACK :

    Back-to-Back

  • PREDICTIVE :

    Predictive Outbound

  • COACH :

    Coaching

OUTBOUND
JobId

string

The call ID.

job-6538214103685****
ChannelId

string

The voice channel ID.

ch:user:1390501****->8032****:1609138902226:job-653821410368****
UserExtension

string

The extension number of the agent associated with the channel.

8032****
Originator

string

The originator of the channel.

0830019****
UserContext

object

Agent context environment.

Extension

string

The agent's extension number.

8032****
Heartbeat

integer

The time when the last heartbeat was received from the agent, in UNIX timestamp format, in milliseconds.

1609136956378
WorkMode

string

Work mode.

Valid values:

  • ON_SITE :

    On-site mode

  • OFF_SITE :

    Off-site mode

  • OFFICE_PHONE :

    Office phone mode

ON_SITE
DeviceId

string

Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.

ACC-YUNBS-1.0.10-****
UserId

string

Agent ID.

agent@ccc-test
Reserved

integer

The most recent time when the agent was reserved. Being reserved means an incoming call will be assigned to the agent shortly. The value is a UNIX timestamp in milliseconds.

1609136956378
BreakCode

string

Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.

Valid values:

  • RingingTimeout :

    Break due to agent ringing timeout

  • RejectCall :

    Break due to agent call rejection

  • Warm-up :

    Temporary break state after an agent is published and before becoming idle

Warm-up
InstanceId

string

instance ID.

ccc-test
OutboundScenario

boolean

Indicates whether the agent is in outbound-only mode.

false
Mobile

string

The agent's personal phone number.

1324730****
JobId

string

Call ID.

job-6538214103685****
UserState

string

Agent status.

Valid values:

  • READY :

    empty

  • WORKING :

    post-processing

  • DIALING :

    dial-up

  • BREAK :

    break

  • OFFLINE :

    offline

  • TALKING :

    talking

  • RINGING :

    ringing

TALKING
SignedSkillGroupIdList

array

List of skill group IDs that the agent has signed into.

string

Skill group ID.

skillgroup1@ccc-test

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Params": [
    "无"
  ],
  "Data": {
    "CallContext": {
      "CallType": "OUTBOUND",
      "InstanceId": "ccc-test",
      "JobId": "job-6538214103685****",
      "ChannelContexts": [
        {
          "Index": 10,
          "ReleaseInitiator": "1390501****",
          "ChannelState": "ANSWERED",
          "Destination": "1390501****",
          "UserId": "agent@ccc-test",
          "ChannelFlags": "MONITORING",
          "SkillGroupId": "skillgroup@ccc-test",
          "Timestamp": 1609138903315,
          "ReleaseReason": "404 - No destination",
          "CallType": "OUTBOUND",
          "JobId": "job-6538214103685****",
          "ChannelId": "ch:user:1390501****->8032****:1609138902226:job-653821410368****",
          "UserExtension": "8032****",
          "Originator": "0830019****"
        }
      ]
    },
    "UserContext": {
      "Extension": "8032****",
      "Heartbeat": 1609136956378,
      "WorkMode": "ON_SITE",
      "DeviceId": "ACC-YUNBS-1.0.10-****",
      "UserId": "agent@ccc-test",
      "Reserved": 1609136956378,
      "BreakCode": "Warm-up",
      "InstanceId": "ccc-test",
      "OutboundScenario": false,
      "Mobile": "1324730****",
      "JobId": "job-6538214103685****",
      "UserState": "TALKING",
      "SignedSkillGroupIdList": [
        "skillgroup1@ccc-test"
      ]
    }
  }
}

Error codes

HTTP status code

Error code

Error message

Description
400 Parameter.Blank The parameter %s may not be null or blank.
500 InternalService.CTI An internal CTI service error occurred. %s
404 NotExists.ChannelId The specified channel %s does not exist in call %s.
404 NotExists.InstanceId The specified instance %s does not exist.
404 NotExists.JobId The call %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.