This resource is used to send SMS message.
As the request is passed to other services and response is asynchronus message-id is returned in response.
It should be used to check bolt unlock operation status.
Current status is returned in response.

Phone number should contain country prefix if different than 48

Resource URL

https://api.safeguard24.eu/{version}/phone/message

Parameters

Parameter Description Required Default
number Mobile number, no spaces and special chars, only digits [0-9] characters accepted. Length: 9-11 characters. yes none
message Message content to send as SMS text body. All characters are allowed but non standard will take 2 bits. Non special chars: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyzÄÖÑܧ¿a-zäöñüà <enter> @£$¥èéùìòÇØøÅå_^{}\[~]|ÆæßÉ!"#¤%&'()*+,-./0-9:;<=>? yes none

Example

PUT
https://api.safeguard24.eu/v1.0/phone/message

Request body

  number: 48100200300
  message: This is a test message
  with new line in it
  Some standard chars like @# are ok.

Response body

  {
    "error": false,
    "msg": "Message accepted",
    "status": 200,
    "_data": {
      "message-id": 1397601756895433440,
      "message-status": "SENT"
    }
  }

Error Response

  {
    "error": true,
    "msg": "Bad Request",
    "status": 400
  }

Resource Information

API version v1.0
Method PUT
Authentication HMAC
Response Format JSON