UserMessageEndpoint
The following resources are applicable:
- /user/message/conversations/delete
- /user/message/conversations/delete/list
- /user/message/conversations/get
- /user/message/conversations/read
- /user/message/delete
- /user/message/delete/list
- /user/message/get/by/conversation
- /user/message/insert
- /user/message/lock/list
- /user/message/search
- /user/message/send
- /user/message/sync
- /user/message/unlock/list
- /user/message/update
/user/message/conversations/delete
Mount Point: /rest/user/message/conversations/delete
POST
Delete a user message conversation and all of it's messages.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userMessageDeleteConversationRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageDeleteConversationResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/message/conversations/delete/list
Mount Point: /rest/user/message/conversations/delete/list
POST
Delete a list of user message conversations and all of it's messages.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userMessageDeleteConversationListRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageDeleteConversationListResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/message/conversations/get
Mount Point: /rest/user/message/conversations/get
POST
Gets a list of user message conversations.
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userMessageGetConversationsRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageGetConversationsResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/message/conversations/read
Mount Point: /rest/user/message/conversations/read
POST
Marks a user message conversation as read.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userMessageReadConversationRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageReadConversationResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/message/delete
Mount Point: /rest/user/message/delete
POST
Deletes a user message.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userMessageDeleteRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageDeleteResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/message/delete/list
Mount Point: /rest/user/message/delete/list
POST
Deletes a list of user messages.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userMessageDeleteListRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageDeleteListResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/message/get/by/conversation
Mount Point: /rest/user/message/get/by/conversation
POST
Gets user messages from a conversation.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userMessageGetMessagesRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageGetMessagesResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/message/insert
Mount Point: /rest/user/message/insert
POST
Inserts a incoming user message.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userMessageInsertRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageInsertResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/message/lock/list
Mount Point: /rest/user/message/lock/list
POST
Locks a list of user messages.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userMessageLockListRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageLockListResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/message/search
Mount Point: /rest/user/message/search
POST
Search user messages.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userMessageSearchRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageSearchResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/message/send
Mount Point: /rest/user/message/send
POST
Send a user 2 user message.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 113 | For this operation the user must have a msisdn associated |
| 105 | The given device id is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userMessageSendRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageSendResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/message/sync
Mount Point: /rest/user/message/sync
POST
Synchronizes Messages between server and device.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 105 | The given device id is invalid. |
| 600 | The api key is invalid |
Request Body
| element: | userMessageSyncRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageSyncResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/message/unlock/list
Mount Point: /rest/user/message/unlock/list
POST
Unlocks a list of user messages.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userMessageUnlockListRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageUnlockListResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/message/update
Mount Point: /rest/user/message/update
POST
Updates a user message.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userMessageUpdateRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userMessageUpdateResponse |
| media types: | */* application/xml application/json |
(no documentation provided)