Continues an existing conversation for which the message posted will be the next, and also last, message. Only in the case of one-on-one conversations can the recipient type be user, for group conversations it should always be conversation.
POST https://api.speakap.io/networks/:eid/messages/
Request
URI: | /networks/{networkEID}/messages/ |
---|---|
Method: | POST |
Content-Type: | application/json |
Authentication: | OAuth 2.0 |
Name | Type | Description |
---|---|---|
networkEID | EID | Network EID |
Supply a complete private message resource in the request body supplemented with
a recipient
object. You should omit the created
date as it will be set server-side.
Name | Type | Description |
---|---|---|
recipient | object | Message recipient |
recipient EID | EID | Unique entity identifier |
recipient type | string | 'user' or 'conversation' |
{
"messageType": "private",
"body": "They're prisons! Man-made prisons! You're doing time.",
"recipient": {
"EID": "1234567890ABCDEF",
"type": "user"
}
}
Response
The response will return both the EID of the newly created message and of the relevant conversation.
Status code: |
---|
See Create Message
Entity body: |
---|
The entity body will be a regular feedback object with the following additional data:
Name | Type | Description |
---|---|---|
conversation | object | Partial conversation object |
conversation. EID | EID | Unique entity identifier |
conversation. new | boolean | false |
conversation. conversationType | string | one-on-one (two people) or group (more than two) |
conversation. started | datetime | Date the conversation was started (ISO 8601 compliant) |
{
"EID":"ABCDEF1234567890",
"status":"Next message in conversation scheduled for insertion",
"uri":"http://io.speakap.com/networks/1234567890ABCDEF/messages/ABCDEF1234567890/",
"data": {
"conversation": {
"EID": "FEDCBA0987654321",
"new": false,
"conversationType": "group",
"lastUpdated": "2014-01-07T15:32:11.442+01:00"
}
}
}