create-voice-channel-visitor.md

Create Voice Channel Visitor

HTTP Method	URL	Requires Auth
POST	/api/v1/livechat/visitor	no

Body Parameters

Key	Example Value	Description
visitor*	{ "visitor": { ... }	Enter the body parameters in the visitor object.
token*	erdsfdjs43828492	Enter a random unique string as the visitor token.
name	John Doe	Visitor's name.
email	john.doe@email.com	Visitor's email ID.
department	Support	The department that the visitor wants to register to.
phone	+37265783468	Visitor's phone number.
username	kim.jane	The agent's user name.
custom fields: key, value, overwite	"customFields": [{ "key": "address", "value": "Rocket.Chat street", "overwrite": true }]	Enter the custom field key, value, and whether you want to overwrite this information.

Example Call

curl --location --request POST 'localhost:3000/api/v1/livechat/visitor' \
--header 'Content-Type: application/json' \
--data-raw '{
    "visitor": {
        "token": "867ad6a09fc4af29f6f1f2a9cf1deaba"
    }
}'

Example Response

{
    "visitor": {
        "_id": "b3c7SMriL729R3J8w",
        "username": "guest-2",
        "status": "online",
        "ts": "2022-06-29T06:05:01.392Z",
        "_updatedAt": "2022-06-29T06:05:01.408Z",
        "token": "867ad6a09fc4af29f6f1f2a9cf1deaba"
    },
    "success": true
}