When control is handed over to a Bot, a notification is published via pass-conversation-control.

Payload

passConversationControl object

Name	Type	Description
type	string Allowed Values: `default` `reset`	The way in which the bot should engage on the conversation. `default`: the bot should engage in the conversation immediately. `reset`: the conversation has halted and the bot should engage only when the customer does.
service	string Example: `facebook`	The social service the credential is for. Today these include, but are not limited to: Facebook Instagram Youtube RSS
privateMessageConversationId	object	The id of the end user’s Twitter account and the id of the Company’s Twitter account together uniquely identify the conversation.
timestampRequested	stringFormat: ISO 8061	The date and time that the request for control change was initiatied.

privateMessageConversationId Object

Name	Type	Description
endUserAccountId	stringExample: `358414673`	The value of the Twitter user_id field for the end user in the conversation. Note: Screen names are not accepted here.
ownedAccountId	stringExample: `3321781046`	The value of the Twitter user_id field for the Company’s Twitter account that is involved in the conversation. Note: Screen names are not accepted here.

Example payload:

{
	"passConversationControl": {
		"type": "<default|reset>",
		"service": "twitter",
		"privateMessageConversationId": {
				"endUserAccountId": "<end_user_account_id>",
				"ownedAccountId": "<owned_account_id>"
		},
		"timestampRequested": "2018-01-01T12:45:02.023Z"
	}
}