Api doc


SDK's


Api Modules

messaging.messages

Retrieve/Delete/Add to the business message wall.



Supported Methods:

GET
Params
  • token (Required): valid token
  • mode: enum (to, from)


Documentation

GET
Returns an array that contains all user messages.
You can specify if you want to retrieve just send, or receive messages, with parameter 'mode'.
Level 5 is required (all users can fetch this module)

--

Parameters:

  1. "mode": accepted //Mode (enum[to,from])
  2. /* to : Recived messages
  3.   * from: Sent messages */
  4. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "module":"messaging.messages",
  3. "method":"GET",
  4. "request":{
  5. "mode":"to"
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":[
  4. {
  5. "id":"1914",
  6. "from":{
  7. "id":"3334",
  8. "name":"Alan Ford"
  9. },
  10. "to":{
  11. "id":"124",
  12. "name":"Bob Rock"
  13. },
  14. "type":"1",
  15. "replyto":"0",
  16. "date_sent":"1338890805",
  17. "date_read":"0",
  18. "subject":"asda",
  19. "message":"sd",
  20. "message_formatted":"sd",
  21. "date_sent_formatted":{
  22. "id":1133,
  23. "timestamp":1338854400,
  24. "month":6,
  25. "day":4,
  26. "year":2012,
  27. "week":23,
  28. "dayid":2,
  29. "weekday":"Mon",
  30. "mname":"Jun",
  31. "formatted":"Jun 4, 2012"
  32. },
  33. "date_read_formatted":[
  34.  
  35. ]
  36. },
  37. {
  38. "id":"1913",
  39. "from":{
  40. "id":"1061",
  41. "name":"Marc Smith"
  42. },
  43. "to":{
  44. "id":"3334",
  45. "name":"Alan Ford"
  46. },
  47. "type":"1",
  48. "replyto":"0",
  49. "date_sent":"1338889951",
  50. "date_read":"1338912286",
  51. "subject":"re: tste",
  52. "message":"it's working :) fine...\n\n\n\n[quote=Alan Ford]tste[\/quote]",
  53. "message_formatted":"it's working :) fine...
  54. \n
  55. \n
  56. \n
  57. \ntste",
  58. "date_sent_formatted":{
  59. "id":1133,
  60. "timestamp":1338854400,
  61. "month":6,
  62. "day":4,
  63. "year":2012,
  64. "week":23,
  65. "dayid":2,
  66. "weekday":"Mon",
  67. "mname":"Jun",
  68. "formatted":"Jun 4, 2012"
  69. },
  70. "date_read_formatted":{
  71. "id":1133,
  72. "timestamp":1338854400,
  73. "month":6,
  74. "day":4,
  75. "year":2012,
  76. "week":23,
  77. "dayid":2,
  78. "weekday":"Mon",
  79. "mname":"Jun",
  80. "formatted":"Jun 4, 2012"
  81. }
  82. },
  83. {
  84. "id":"1910",
  85. "from":{
  86. "id":"3334",
  87. "name":"Alan Ford"
  88. },
  89. "to":{
  90. "id":"5141",
  91. "name":"Steewe"
  92. },
  93. "type":"1",
  94. "replyto":"0",
  95. "date_sent":"1338889909",
  96. "date_read":"1338912226",
  97. "subject":"tst",
  98. "message":"tst",
  99. "message_formatted":"tst",
  100. "date_sent_formatted":{
  101. "id":1133,
  102. "timestamp":1338854400,
  103. "month":6,
  104. "day":4,
  105. "year":2012,
  106. "week":23,
  107. "dayid":2,
  108. "weekday":"Mon",
  109. "mname":"Jun",
  110. "formatted":"Jun 4, 2012"
  111. },
  112. "date_read_formatted":{
  113. "id":1133,
  114. "timestamp":1338854400,
  115. "month":6,
  116. "day":4,
  117. "year":2012,
  118. "week":23,
  119. "dayid":2,
  120. "weekday":"Mon",
  121. "mname":"Jun",
  122. "formatted":"Jun 4, 2012"
  123. }
  124. },
  125. {
  126. "id":"1909",
  127. "from":{
  128. "id":"3334",
  129. "name":"Alan Ford"
  130. },
  131. "to":{
  132. "id":"1064",
  133. "name":"Alicia"
  134. },
  135. "type":"1",
  136. "replyto":"0",
  137. "date_sent":"1338889909",
  138. "date_read":"1338912214",
  139. "subject":"tst",
  140. "message":"tst",
  141. "message_formatted":"tst",
  142. "date_sent_formatted":{
  143. "id":1133,
  144. "timestamp":1338854400,
  145. "month":6,
  146. "day":4,
  147. "year":2012,
  148. "week":23,
  149. "dayid":2,
  150. "weekday":"Mon",
  151. "mname":"Jun",
  152. "formatted":"Jun 4, 2012"
  153. },
  154. "date_read_formatted":{
  155. "id":1133,
  156. "timestamp":1338854400,
  157. "month":6,
  158. "day":4,
  159. "year":2012,
  160. "week":23,
  161. "dayid":2,
  162. "weekday":"Mon",
  163. "mname":"Jun",
  164. "formatted":"Jun 4, 2012"
  165. }
  166. },
  167. {
  168. "id":"1908",
  169. "from":{
  170. "id":"3334",
  171. "name":"Alan Ford"
  172. },
  173. "to":{
  174. "id":"5141",
  175. "name":"Steewe"
  176. },
  177. "type":"1",
  178. "replyto":"0",
  179. "date_sent":"1338889886",
  180. "date_read":"1338912217",
  181. "subject":"msg",
  182. "message":"ngs",
  183. "message_formatted":"ngs",
  184. "date_sent_formatted":{
  185. "id":1133,
  186. "timestamp":1338854400,
  187. "month":6,
  188. "day":4,
  189. "year":2012,
  190. "week":23,
  191. "dayid":2,
  192. "weekday":"Mon",
  193. "mname":"Jun",
  194. "formatted":"Jun 4, 2012"
  195. },
  196. "date_read_formatted":{
  197. "id":1133,
  198. "timestamp":1338854400,
  199. "month":6,
  200. "day":4,
  201. "year":2012,
  202. "week":23,
  203. "dayid":2,
  204. "weekday":"Mon",
  205. "mname":"Jun",
  206. "formatted":"Jun 4, 2012"
  207. }
  208. },
  209. {
  210. "id":"1907",
  211. "from":{
  212. "id":"234",
  213. "name":"Peter Griffin"
  214. },
  215. "to":{
  216. "id":"1064",
  217. "name":"Alicia"
  218. },
  219. "type":"1",
  220. "replyto":"0",
  221. "date_sent":"1338889886",
  222. "date_read":"1338912218",
  223. "subject":"msg",
  224. "message":"ngs",
  225. "message_formatted":"ngs",
  226. "date_sent_formatted":{
  227. "id":1133,
  228. "timestamp":1338854400,
  229. "month":6,
  230. "day":4,
  231. "year":2012,
  232. "week":23,
  233. "dayid":2,
  234. "weekday":"Mon",
  235. "mname":"Jun",
  236. "formatted":"Jun 4, 2012"
  237. },
  238. "date_read_formatted":{
  239. "id":1133,
  240. "timestamp":1338854400,
  241. "month":6,
  242. "day":4,
  243. "year":2012,
  244. "week":23,
  245. "dayid":2,
  246. "weekday":"Mon",
  247. "mname":"Jun",
  248. "formatted":"Jun 4, 2012"
  249. }
  250. }
  251. ],
  252. "token":"xxxxxxx"
  253. }

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