Api doc


SDK's


Api Modules

messaging.shift

Send a message to all staff on a shift.



Supported Methods:

CREATE
Params
  • token (Required): valid token
  • subject (Required): varchar
  • message (Required): varchar
  • id (Required): integer


Documentation

CREATE
Send a message to all staff in shift.
Level 5 is required (all users can fetch this module)

--

Parameters:

  1. "subject": required //Message subject (varchar)
  2. "message": required //Message body (varchar)
  3. "id": required //Shift id (integer)
  4. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"messaging.shift",
  3. "method":"CREATE",
  4. "request":{
  5. "subject":"test",
  6. "message":"body",
  7. "id":"821"
  8. }
  9. }

Example Response:

  1. {
  2. "status":"1",
  3. "data":{
  4. "messages":[
  5. {
  6. "id":"3244",
  7. "from":{
  8. "id":"2",
  9. "name":"John Smith"
  10. },
  11. "to":{
  12. "id":"156",
  13. "name":"Alan Ford"
  14. },
  15. "type":"1",
  16. "replyto":"0",
  17. "date_sent":"1339601203",
  18. "date_read":"0",
  19. "subject":"Test",
  20. "message":"Body",
  21. "message_formatted":"Body",
  22. "date_sent_formatted":{
  23. "id":"1141",
  24. "timestamp":"1339545600",
  25. "month":"6",
  26. "day":"12",
  27. "year":"2012",
  28. "week":"24",
  29. "day_id":"3",
  30. "weekday":"Tue",
  31. "mname":"Jun",
  32. "formatted":"Jun 12, 2012"
  33. },
  34. "date_read_formatted":{
  35.  
  36. }
  37. }
  38. ]
  39. },
  40. "token":"xxxxxxx"
  41. }

GET STARTED NOW

Free Trial. No Credit Card Required.

close
(e.g.+14158675309 or +1415-8675-309)

By clicking "Create my ShiftPlanning Account" you agree to the Terms of Service and Privacy Policy.

Have a promotional code?Click Here


LIVE CHAT DEMO REQUEST!

Please provide information below.

close
INSTANT DEMOSCHEDULED DEMO
Connect with a ShiftPlanning Team Member for a live demo right now!
 

RESELLER REQUEST!

Please provide information below.

close