CreateContactFlow

更新时间:
复制 MD 格式

Creates an IVR flow.

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

Name

string

Yes

Contact flow name.

默认流程

Definition

string

Yes

IVR content.

{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好,欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}

Description

string

Yes

Version description.

1.0

Type

string

Yes

Flow type.
Main flow: MAIN_FLOW
Child flow: SUB_FLOW
Survey flow: SURVEY_FLOW


MAIN_FLOW

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

HTTP status code.

200

Code

string

Response code.

OK

Message

string

Response message.

Data

string

IVR contact flow ID.

78128960-bb00-4ddc-8e82-923a8c5bd22d

RequestId

string

Request ID.

2778FA12-EDD6-42AA-9B15-AF855072E5E5

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "无",
  "Data": "78128960-bb00-4ddc-8e82-923a8c5bd22d",
  "RequestId": "2778FA12-EDD6-42AA-9B15-AF855072E5E5"
}

Error codes

HTTP status code

Error code

Error message

Description

404 NotExists.InstanceId The specified instance %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.