Messages are sent from worker to dispatcher and vice versa. Messages are contained within a message thread.
You can add or delete messages threads using this API.
If you add a Job ID, we will automatically send it to the workers for that job, you do not need to specify the worker ID.
Here are the fields you can use when making a message request:
| Name | Type | Description |
|---|---|---|
| job_id | Integer | An optional job ID that the message thread relates to. |
| job_third_party_id | String | An optional job Third Party ID that the message thread relates to. |
| user_ids | String | Comma-separated list of ids of users you want to the message to be available to. |
| subject | String | The subject for the thread. |
| messages | Array | An array of messages to add to the thread. |
| message.from_user_id | Integer | User ID for initial thread message. (Optional) |
| message.from_user_name | String | User name of message creator. Only used (and required) if from_user_id is blank. |
| message.body | String | The body for the inital thread message. |
When retrieving a message from vWork, you may also see these additional fields in the response:
| Name | Type | Description |
|---|---|---|
| id | Integer | Unique ID of thread. |
| summary | Boolean | Summary of latest thread contents (Used internally and set automatically.) |
| last_reply_user_id | Boolean | User ID of last reply. |
| last_reply_at | Boolean | Time thread was last replied to. |
| created_at | DateTime | Time thread was created. |
| updated_at | DateTime | Time thread was last updated. |
| messages | Array | An array of all messages in the thread. |
| created_by_user_id | Boolean | User ID of thread creator. |
| message.id | String | Unique Message ID. |
| message.read_by_user_ids | String | Comma-separated list of IDs of users that have read the message. |
| message.received_by_user_ids | String | Comma-separated list of IDs of users that have received this message on their mobile devices. |
| message.created_at | DateTime | Time message was created. |
| message.updated_at | DateTime | Time message was last updated. |
Creates a new message thread (including an initial message) in vWork.
Security
apiKey
POST
curl -i -X POST \
'https://api.vworkapp.com/v5/messaging.xml?api_key=string&api_key=YOUR_API_KEY_HERE' \
-H 'Accept-Encoding: gzip' \
-H 'Content-Type: application/xml; charset=utf-8' \
-d '<?xml version="1.0" encoding="utf-8"?>
<thread>
<job_id/>
<user_ids>123</user_ids>
<subject>Sample Thread</subject>
<messages type="array">
<message>
<from_user_id/>
<from_user_name>Joe Bloggs</from_user_name>
<body>Sample Message</body>
</message>
</messages>
</thread>'Created
Headers
Example:"frame-ancestors *.vworkapp.com *.vwork.io *.visfleet.com *.salesforce.com *.zoho.com, default-src: google.com google-analytics.com googleapis.com gst
Example:"https://api.vworkapp.com/api/v4/messaging/ded86e04-31d0-11e6-927a-37a1480f7e3a.xml"
string
Raw XML payload — see the example.
Response
<?xml version="1.0" encoding="utf-8"?>
<thread>
<id>ded86e04-31d0-11e6-927a-37a1480f7e3a</id>
<job_id/>
<user_ids>123</user_ids>
<all_workers>false</all_workers>
<created_by_user_id/>
<subject>Sample Thread</subject>
<summary>Sample Message</summary>
<last_reply_user_id/>
<last_reply_at>2016-06-14T01:39:44Z</last_reply_at>
<created_at>2016-06-14T01:39:44Z</created_at>
<updated_at>2016-06-14T01:39:45Z</updated_at>
<messages type="array">
<message>
<id>23275dfc-086d-11e4-a5ac-174e8ef2ef84</id>
<thread_id>23268152-086d-11e4-a5ac-174e8ef2ef84</thread_id>
<from_user_id/>
<from_user_name>Joe Bloggs</from_user_name>
<read_by_user_ids/>
<received_by_user_ids/>
<body>Sample Message</body>
<created_at>2014-07-10 20:02:36 UTC</created_at>
<updated_at>2014-07-11 08:02:36 +1200</updated_at>
</message>
</messages>
</thread>