Engage

Getting started
Changelog
Supported message types by channel
Message Schemas
Response Operations
Callbacks
Authorization
- Authorizationpost
Conversations
Messages
- Append messagepost
- Delete message(s)delete
Participants
Groups
Teams
Skills
- Fetch list of skillsget
Users
User_Presence
Business Hours
Holiday Lists
Overrides Lists

Engage

Getting started
Changelog
Supported message types by channel
Message Schemas
Response Operations
Callbacks
Authorization
- Authorizationpost
Conversations
Messages
- Append messagepost
- Delete message(s)delete
Participants
Groups
Teams
Skills
- Fetch list of skillsget
Users
User_Presence
Business Hours
Holiday Lists
Overrides Lists

Create conversation

post https://api-us-site-1.imiengage.io/api/v1/conversations

GBM channel has been deprecated post WxEngage's Release v5.8 as Google has called off support for the channel

Create a conversation. This request will be executed against the configured Routing rules within Engage

URL Expired

The URL for this request expired after 30 days.

Body Params

data

object

required

callback

object

required

Definition of the 'Callback' model

Responses

Headers

object

tid

string

Unique transaction ID returned in response to a request - need to be stored by the consumer for debugging/support

Response body

object

status

string

required

Determines whether the operation was a success or failure

failed

code

integer

required

A numeric code that maps to the description of the outcome of the operation requested

description

string

required

Description of the outcome of the operation requested

value

object | null

required

Operation specific payload

Has additional fields

Headers

object

tid

string

Unique transaction ID returned in response to a request - need to be stored by the consumer for debugging/support

Response body

object

status

string

required

Determines whether the operation was a success or failure

failed

code

integer

required

A numeric code that maps to the description of the outcome of the operation requested

description

string

required

Description of the outcome of the operation requested

value

object | null

required

Operation specific payload

Has additional fields

Headers

object

tid

string

Unique transaction ID returned in response to a request - need to be stored by the consumer for debugging/support

Response body

object

status

string

required

Determines whether the operation was a success or failure

failed

code

integer

required

A numeric code that maps to the description of the outcome of the operation requested

description

string

required

Description of the outcome of the operation requested

value

object | null

required

Operation specific payload

Has additional fields

Headers

object

tid

string

Unique transaction ID returned in response to a request - need to be stored by the consumer for debugging/support

Response body

object

status

string

required

Determines whether the operation was a success or failure

failed

code

integer

required

A numeric code that maps to the description of the outcome of the operation requested

description

string

required

Description of the outcome of the operation requested

value

object | null

required

Operation specific payload

Has additional fields

Headers

object

tid

string

Unique transaction ID returned in response to a request - need to be stored by the consumer for debugging/support

Response body

object

status

string

required

Determines whether the operation was a success or failure

failed

code

integer

required

A numeric code that maps to the description of the outcome of the operation requested

description

string

required

Description of the outcome of the operation requested

value

object | null

required

Operation specific payload

Has additional fields

Headers

object

tid

string

Unique transaction ID returned in response to a request - need to be stored by the consumer for debugging/support

Response body

object

status

string

required

Determines whether the operation was a success or failure

failed

code

integer

required

A numeric code that maps to the description of the outcome of the operation requested

description

string

required

Description of the outcome of the operation requested

value

object | null

required

Operation specific payload

Has additional fields

Headers

object

tid

string

Unique transaction ID returned in response to a request - need to be stored by the consumer for debugging/support

Updated 5 months ago

Search conversation

Update conversation

Did this page help you?

Language

Credentials

OAuth2

Bearer

URL


xxxxxxxxxx
18
1
curl --request POST \
2
     --url https://api-us-site-1.imiengage.io/api/v1/conversations \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "data": {
8
    "channel": "sms",
9
    "messages": [
10
      {
11
        "direction": "inbound",
12
        "type": "text",
13
        "redacted": true
14
      }
15
    ]
16
  }
17
}
18
'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

Updated 5 months ago

Search conversation

Update conversation

Did this page help you?

Engage
Getting started
Changelog
Supported message types by channel
Message Schemas
API message schema
AMB message schema
WhatsApp message schema
Email message schema
Livechat message schema
FBM message schema
SMS message schema
Response Operations
Callbacks
Authorization
Authorizationpost
Conversations
Fetch conversation notesget
Fetch conversation transcriptget
Transfer conversationpost
Update conversationpatch
Create conversationpost
Search conversationpost
Messages
Delete message(s)delete
Append messagepost
Participants
Fetch list of current participantsget
Remove participantdelete
Add participantpost
Groups
(TBD) Delete a Groupdelete
(TBD) Update a Grouppatch
(TBD) Fetch a Group's detailsget
(TBD) Create a Grouppost
(TBD) Fetch list of Groupsget
Teams
Fetch a team's working hoursget
(TBD) Delete a Teamdelete
(TBD) Update a Teampatch
(TBD) Fetch a Team's detailsget
(TBD) Create a Teampost
(TBD) Fetch list of Teamsget
Skills
Fetch list of skillsget
Users
Update a single userpatch
(TBD) Fetch a user's detailsget
(TBD) Create users in bulkpost
Update user's presence in a teampost
(TBD) Create a single userpost
Fetch user presenceget
(TBD) Fetch list of usersget
User_Presence
Business Hours
(TBD) Delete a Business Hours object by IDdelete
(TBD) Update a Business Hours object by IDpatch
(TBD) Fetch a Business Hours object by IDget
(TBD) Create a Business Hours objectpost
Fetch the list of Business Hoursget
Holiday Lists
(TBD) Delete a Holiday List by IDdelete
(TBD) Update Holiday List by IDpatch
(TBD) Fetch Holiday List by IDget
(TBD) Create a Holiday Lists objectpost
(TBD) Fetch the list of Holiday Listsget
Overrides Lists
(TBD) Delete an individual Overrides List by IDdelete
(TBD) Update an individual Overrides List by IDpatch
(TBD) Fetch an individual Overrides List by IDget
(TBD) Create an Override Listpost
(TBD) Fetch list of Overrides Listsget

Engage
Getting started
Changelog
Supported message types by channel
Message Schemas
API message schema
AMB message schema
WhatsApp message schema
Email message schema
Livechat message schema
FBM message schema
SMS message schema
Response Operations
Callbacks
Authorization
Authorizationpost
Conversations
Fetch conversation notesget
Fetch conversation transcriptget
Transfer conversationpost
Update conversationpatch
Create conversationpost
Search conversationpost
Messages
Delete message(s)delete
Append messagepost
Participants
Fetch list of current participantsget
Remove participantdelete
Add participantpost
Groups
(TBD) Delete a Groupdelete
(TBD) Update a Grouppatch
(TBD) Fetch a Group's detailsget
(TBD) Create a Grouppost
(TBD) Fetch list of Groupsget
Teams
Fetch a team's working hoursget
(TBD) Delete a Teamdelete
(TBD) Update a Teampatch
(TBD) Fetch a Team's detailsget
(TBD) Create a Teampost
(TBD) Fetch list of Teamsget
Skills
Fetch list of skillsget
Users
Update a single userpatch
(TBD) Fetch a user's detailsget
(TBD) Create users in bulkpost
Update user's presence in a teampost
(TBD) Create a single userpost
Fetch user presenceget
(TBD) Fetch list of usersget
User_Presence
Business Hours
(TBD) Delete a Business Hours object by IDdelete
(TBD) Update a Business Hours object by IDpatch
(TBD) Fetch a Business Hours object by IDget
(TBD) Create a Business Hours objectpost
Fetch the list of Business Hoursget
Holiday Lists
(TBD) Delete a Holiday List by IDdelete
(TBD) Update Holiday List by IDpatch
(TBD) Fetch Holiday List by IDget
(TBD) Create a Holiday Lists objectpost
(TBD) Fetch the list of Holiday Listsget
Overrides Lists
(TBD) Delete an individual Overrides List by IDdelete
(TBD) Update an individual Overrides List by IDpatch
(TBD) Fetch an individual Overrides List by IDget
(TBD) Create an Override Listpost
(TBD) Fetch list of Overrides Listsget

202Accepted

400Bad request

401Unauthorized

404Not found

405Method not allowed

429Too many requests

500Internal server error