Intelligent Media Services:API operation details

state

Obtains the engine connection status. For more information about ARTCAIChatEngineState, see ARTCAIChatEngineState.

var state: ARTCAIChatEngineState { get }

userInfo

Obtains the information about the user who participates in the current session. For more information about ARTCAIChatUserInfo, see ARTCAIChatUserInfo.

var userInfo: ARTCAIChatUserInfo? { get }

sessionId

Obtains the unique identifier of the current session.

var sessionId: String? { get }

agentInfo

Obtains the information about the agent that participates in the current session. For more information about ARTCAIChatAgentInfo, see ARTCAIChatAgentInfo.

var agentInfo: ARTCAIChatAgentInfo? { get }

agentResponeState

Obtains the current agent response status. For more information about ARTCAIChatAgentResponseState, see ARTCAIChatAgentResponseState.

var agentResponeState: ARTCAIChatAgentResponseState { get }

voiceIdList

Obtains the current voice list.

var voiceIdList: [String] { get }

delegate

Configures and queries callback events. For more information about ARTCAIChatEngineDelegate, see ARTCAIChatEngineDelegate.

weak var delegate: ARTCAIChatEngineDelegate? { get set }

templateConfig

Sets and obtains TemplateConfig. For more information about ARTCAIChatTemplateConfig, see ARTCAIChatTemplateConfig.

var templateConfig: ARTCAIChatTemplateConfig? { get set }

userData

Custom user information that is passed to the agent.

var userData: [String: Any]? { get set }

startChat

Starts a chat session.

func startChat(userInfo: ARTCAIChatUserInfo, agentInfo: ARTCAIChatAgentInfo, sessionId: String?)

Parameters:

endChat

Ends a chat session.

func endChat(needLogout: Bool)

Parameters:

sendMessage

Sends a message and interrupts the current reply (if the agent is thinking or replying).

func sendMessage(request: ARTCAIChatSendMessageRequest, completed:((_ msg: ARTCAIChatMessage?, _ error: NSError?) -> Void)?)

Parameters:

deleteMessage

Deletes a message.

func deleteMessage(message: ARTCAIChatMessage, completed:((_ error: NSError?) -> Void)?)

Parameters:

queryMessageList

Requests the historical message list.

func queryMessageList(request: ARTCAIChatMessageListRequest, completed:((_ msgList: [ARTCAIChatMessage]?, _ error: NSError?) -> Void)?)  

Parameters:

interruptAgentResponse

Interrupts the current message reply.

func interruptAgentResponse()

deleteMessage

Deletes a message.

func deleteMessage(dialogueId: String, completed:((_ error: NSError?) -> Void)?)

Parameters:

startPlayMessage

Starts playing the message content.

func startPlayMessage(message: ARTCAIChatMessage, voiceId: String?, completed: ((NSError?) -> Void)?)

Parameters:

stopPlayMessage

Stops playing the message.

func stopPlayMessage()

isPlayingMessage

Checks whether a message is being played.

func isPlayingMessage(dialogueId: String) -> Bool

createAttachmentUploader

Creates an attachment uploader object to send messages with images, videos, or files.

func createAttachmentUploader() -> ARTCAIChatAttachmentUploader?

startPushVoiceMessage

Starts push-to-talk voice messaging. When you press the button, recording starts and the voice is sent in real time. Make sure that the recording permission is enabled.

A return value of true indicates that the operation is successful. A return value of false indicates that the operation failed. Common causes include incorrect status and disabled recording permission.

func startPushVoiceMessage(request: ARTCAIChatSendMessageRequest) -> Bool

Parameters:

finishPushVoiceMessage

Ends push-to-talk voice messaging. This operation is called when you release the button, indicating that the current voice message is sent and the system is waiting for the agent to respond.

func finishPushVoiceMessage(completed:((_ msg: ARTCAIChatMessage) -> Void)?)

Parameters:

cancelPushVoiceMessage

Cancels push-to-talk voice messaging. This operation is called when you release the button, indicating that the current voice message is canceled.

func cancelPushVoiceMessage()

destroy

Releases resources.

func destroy()

parseShareAgentChat

Parses the information about a shared intelligent agent.

func parseShareAgentChat(shareInfo: String) -> ARTCAIChatAgentShareConfig?

Parameters:

generateShareAgentChat

Starts a call with a shared intelligent agent.

func generateShareAgentChat(shareConfig: ARTCAIChatAgentShareConfig, userId: String, completed: ((_ agentInfo: ARTCAIChatAgentInfo?, _ authToken: ARTCAIChatAuthToken?, _ error: NSError?, _ reqId: String) -> Void)?)    

Parameters:

onErrorOccurs

An error occurred.

@objc optional func onErrorOccurs(error: NSError, requestId: String?)

Parameters:

onRequestAuthToken

Requests an AuthToken. This callback is triggered when the ChatEngine needs to log on to IM or when the AuthToken for IM logon expires.

@objc optional func onRequestAuthToken(userId: String, responseBlock: @escaping (_ authToken: ARTCAIChatAuthToken?, _ error: NSError?)->Void)

Parameters:

onEngineStateChange

The agent connection status changes.

@objc optional func onEngineStateChange(state: ARTCAIChatEngineState)

Parameters:

onReceivedMessage

A reply message is received from the agent. This callback is triggered when the agent sends a new reply or when the status of a message changes during the current reply process.

@objc optional func onReceivedMessage(message: ARTCAIChatMessage)

Parameters:

onReceivedCustomMessage

A custom message is received.

@objc optional func onReceivedCustomMessage(text: String)

Parameters:

onUserMessageUpdated

A message sent by the user needs to be updated.

@objc optional func onUserMessageUpdated(message: ARTCAIChatMessage)

Parameters:

onAgentResponeStateChange

The agent response status changes.

@objc optional func onAgentResponeStateChange(state: ARTCAIChatAgentResponseState, requestId: String?)

Parameters:

onMessagePlayStateChange

The message playback status of the Chat agent changes.

@objc optional func onMessagePlayStateChange(message: ARTCAIChatMessage, state: ARTCAIChatMessagePlayState)

Parameters:

createChatEngine

Creates a default Chat agent engine.

public static func createChatEngine() -> ARTCAIChatEngineInterface