GroupEndpoint
The following resources are applicable:
- /group/create
- /group/get/groups
- /group/get/users
- /group/invite/users
- /group/leave
- /group/rename
- /group/send/message
/group/create
Mount Point: /rest/group/create
POST
Creates an new group with a list of mobile numbers that should be invited. The mobile numbers must belong to valid user accounts.
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 |
| 600 | The api key is invalid |
| 1001 | The number of group users is exceeded |
Request Body
| element: | groupCreateRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | groupCreateResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/group/get/groups
Mount Point: /rest/group/get/groups
POST
Get all group's the user belongs.
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: | groupGetGroupsRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | groupGetGroupsResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/group/get/users
Mount Point: /rest/group/get/users
POST
Get the mobile numbers of all group user's.
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 |
| 1000 | The user is no group user. |
Request Body
| element: | groupGetUsersRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | groupGetUsersResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/group/invite/users
Mount Point: /rest/group/invite/users
POST
Invites a list of mobile numbers to the group. The mobile numbers must belong to valid user accounts.
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 |
| 600 | The api key is invalid |
| 1000 | The user is no group user. |
| 1001 | The number of group users is exceeded |
Request Body
| element: | groupInviteUsersRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | groupInviteUsersResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/group/leave
Mount Point: /rest/group/leave
POST
Leave a group.
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: | groupLeaveRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | groupLeaveResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/group/rename
Mount Point: /rest/group/rename
POST
Renames a group. It is required to be a user of the group.
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 |
| 600 | The api key is invalid |
| 1000 | The user is no group user. |
Request Body
| element: | groupRenameRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | groupRenameResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/group/send/message
Mount Point: /rest/group/send/message
POST
Sends a message to all group user's.
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 |
| 1000 | The user is no group user. |
Request Body
| element: | groupSendMessageRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | groupSendMessageResponse |
| media types: | */* application/xml application/json |
(no documentation provided)