Operation Definitions
Endpoints
GET /api/message/{sqs_type}
Summary
Get message from the queue. An example with the sqs_type is GET /message/site.
The maximum amount of messages that can be received is 10 multiplied by the amount of regions.
Note
Delete the message after processing, otherwise the message becomes available and is received again.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | The integrator token created previously |
header |
| string | Yes | The identifier of the company in the Portal |
Responses
Field Name | Type | Schema |
|---|---|---|
| array | |
| array |
POST /api/message/{sqs_type}
Summary
Delete messages from the queue. An example with the sqs_type is POST /api/message/site.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes |
|
header |
| string | Yes | The integrator token created previously |
header |
| string | Yes | The identifier of the company in the Portal |
body |
| Yes | The array of messages |
Responses
Field Name | Type | Schema |
|---|---|---|
| array | |
| array |
Data Models
GetMessageResponseBody
Field Name | Type | Description |
|---|---|---|
| string | The URL of the queue the message was pulled from |
| string | The message unique identifier (UID) |
| string | Used to delete the message |
| string | |
| string | The payload data |
Sample Response Body
{ "messages": [ { "sqs_url": "https://sqs.us-east-1.amazonaws.com/500483111163 /dev-5a0ec33aae89b51400620e27_5a0ec33a83f32d1500d5006b", "msg_id": "15dcfaf3-0244-4f6d-8c94-ebf60798b4f1", "receipt_handle": "AQEBEt8itINH/uQtYNk1+HFot3RjDQv4kQ+Yl4JyQskhJg7 Zu6mk/M0kv60F53XNDd6srqZ84+2ee6MyQ4ua5xEh0If9lNrfV/HC6+ltNosG9F5LNifHVa6cPHKoR Z+3XocRzrFeLJ4xSEuDSN5fF0lzOdd0bnjfJz7QkK0IvyAPRbIMFR6PdT5oPtroGFW/Da9gGE84iGb fGCGDRxPQyDCOJ6qGg9T5NtlvGWfQbyPWMRP/i1+XUypXKTQG0QKsT74GMUmWhBMlNtY3UjA7jbZhu QzT4NMxwRDfaVu8cB5SUDKrCH4XT8FCHnjp6O0e8/ei1j2B6hIN2ryvk2Fw3qy2njkX1xVLkjlYoPw Qd9ja7WOINAMZCOtNOHBblKHrSNoiMk57R51boJeX/8rvo5UM0XK/RE0mXBR3CewVNW4rUMWeaAsfX pZr6/Z0rque0Ghu", "md5_of_body": "8ad8757baa8564dc136c1e07507f4a98", "body": "test3" }, { "sqs_url": "https://sqs.us-east-1.amazonaws.com/500483111163 /dev-5a0ec33aae89b51400620e27_5a0ec33a83f32d1500d5006b", "msg_id": "8766be31-6b82-4d86-9ea0-0d44664c1739", "receipt_handle": "AQEBPyNrGnbLOpbc6xH8u9S5EACeZJ8TTfB+kXav3iaQHAm LgqHXhL0Yy3Y5brCs9Cvylc9V9sffaf+G9k/NzFd41jvJ3GetD79RtxdhAVWtPJOVEE4UejyA5jKaK CwCnvzt1HMA21Qzd5Q49SZHoNxHzrs7h23KSgJheL7rX+C5nVna8GoWEXkq5z2bdM9tRg2yS0eTm5Z F8HR8ydfGAVOaQ/aTfM3+RgxmjCLTLbyhSG8eX5Lwca3OR26ukSuAIGokzXvxbxhj8VUcF4FZQWW8y mJhZK5kVqU4b8VtZNnWAPvJTrn5RAFB/qR9czkcOXbM3oflWg+99EsBNmQJWt1oM+cK0z0fvHWgb76 KUgHl3QZu3U397CB+Sy3mPaC7vaGCID4vK2UuC6dXgW14lxlW1VzGGM1CnhAheYDm5YOs/h86/bsO8 lhUbnAdRQkeQmzB", "md5_of_body": "c1a8e059bfd1e911cf10b626340c9a54", "body": "test10" }, { "sqs_url": "https://sqs.us-east-1.amazonaws.com/500483111163 /dev-5a0ec33aae89b51400620e27_5a0ec33a83f32d1500d5006b", "msg_id": "dcd6975c-8727-4114-bced-79558a7e275f", "receipt_handle": "AQEBW/Kh58JGlv4RqKEJ2KlL9eCHeulFYzbHyjaluoDM335 kL/BWLp/LHYCU0f1eIa/PjALtWVnBkcIJ3Qi31jJNIoMHTo0TIoAcRGXxInCtHIT9MoDrOG07UWxGy Xp1jBNHQW1/aVuZ33+W5Yaqi6zwyPEzVe/vxj4MCuxr3vvCAXgOM4RdHVBxs8fTEuLAMB0FzOj/Y6S Tt2NmRY3UO3rKxVhiFvbeoS9DMFjyGMP7M+IYxlXndOe3yNe+SgVuY0P0mYnLAdef6X9eppaEi69f2 MA3cHYRfX6ngmVM9C6spCiqZFmSWtc3NY5uAKKZyTDpmwnix8UXGwLNkHmMoHvbRWv66pF4QAykWx+ 7vjTyERqPag37twChZehdBlblNi/p0CUU3E9emuzmlkMvxdTHtcIS/wtPMOfcrPFH0wq5t/xqitmmH ka4EKJbuzr9fR/T", "md5_of_body": "33fc3dbd51a8b38a38b1b85b6a76b42b", "body": "test13" }, { "sqs_url": "https://sqs.us-west-2.amazonaws.com/500483111163 /dev-5a0ec33aae89b51400620e27_5a0ec33a83f32d1500d5006b", "msg_id": "b79ae191-0bab-4908-b4c0-fd89c04514e1", "receipt_handle": "AQEBQMNFJGfu+umMEvtkxogJVQllEhtB4gFZ8sC8j2WBQ9n EWnBxE3VtKgRiUNJQvXyIpiVZo5rH8ftEfRKawjrthtlYRo4LkaC/O/lID3LybIBMbhBVM6kU8v1Lm al0kDu0d7asmcPVgDz1ecO+tsR/if8mK/t9U/sPq06xZ1Ja4rEJvvw9x1lI4A/UjuQtKEYGSUxFmD1 +eMRXvWwVIVxTrG/UEhK+/So/uSVbNNAsRvnNzwSkRz8Y80v7CZKbnNSH6R2r4Ik8kNCHt44+yDUK6 80VRof0z3kax2EF0Cv8XwzyBHx6soF2SeCLf6+nLccmBVuBnukyhPmxd3E3lPaIlb+Cq8oOwqrjKaL nHmSxHdyRgfQHTppsrSG2f7A21WsqNNYupLStmoOIdlnGa5HL8y3ADAbuarsYlZ38gIrxuQznziFRf 28tlTrQgcwX5KNy", "md5_of_body": "46c2f75450cc4869dfe5ff0eb7fe202c", "body": "westtest2" } ],
GetMessageErrorsResponseBody
Field Name | Type | Description |
|---|---|---|
| string | Message example: |
| string | The Simple Queue Service (SQS) name |
| string | The SQS region |
| boolean | The flag that indicates whether an error was received from the main region SQS |
Sample Response Body
"errors": [ { "code": "NonExistentQueue", "sqs_name": "dev-5a0ec33aae89b51400620e27_5a0ec33a83f32d1500d5006b", "sqs_region": "us-west-1", "is_main_source": false } ]
DeleteMessageRequestBody
Field Name | Type | Description |
|---|---|---|
| string | The URL of the queue the message was pulled from |
| string | The message identifier received when getting the message |
| string | Received when getting the message. Used to delete the message. |
| string | The action for the request. Example: Delete. |
Sample Request Body
[ { "sqs_url": "https://sqs.us-east-1.amazonaws.com/500483111163 /dev-5898ed7fc8e8fa1e23870aff_5a2a6de78e29ae1200ffe0d9", "msg_id": "bba080d6-2b83-4571-ac3b-5f0c42287bb0", "receipt_handle": "AQEB2gojvHLU6VmMSc1Bkug+MUecdVjwWyZwGlfg /MKglq9SB4A00vRXcEvQYwJP/IvAYvwcp6PUsZwlkB3akDjYcLeyt3Z5qF8Rq3+gWj6g 8osb3FAk1vuII5eFhIvLVfNjV1vTU99toqPLKAe1qCyllAm2rgFW1vGXXc4Va2Z88APn SsxEqb3MdWhF12GtqvDdcBqx7RHXs292v8+uaGHeg67Wt/2yLu+kaIm+9gbEVD4zaFhY 8zF/1JkhgkQ2zwt+P0MhLmrwCemcUyi7SArEONBHN98CB/4kZy5+0jEa/0VzvMedQJ8d f8xGq0tHVcVXhdcdMkdakly5E2y+6NfZ3T8KJCaoOxUnEYpNit5II2NdS1lMVSrvV7Tg Osd+XSfx7d3k4gTgVsJ5cTF20UN4USY24kpFMolSEo6PXbCviG062f/L3xRskplxkh3bvE/M", "action": "delete" }, { "sqs_url": "https://sqs.us-east-1.amazonaws.com/500483111163 /dev-5898ed7fc8e8fa1e23870aff_5a2a6de78e29ae1200ffe0d9", "msg_id": "ccc110d6-aaaa-4993-ac3b-777c42287880", "receipt_handle": "AQEB2gojvHLU6VmMSc1Bkug+MUecdVjwWyZwGlfg /MKglq9SB4A00vRXcEvQYwJP/IvAYvwcp6PUsZwlkB3akDjYcLeyt3Z5qF8Rq3+gWj6g8 osb3FAk1vuII5eFhIvLVfNjV1vTU99toqPLKAe1qCyllAm2rgFW1vGXXc4Va2Z88APnSsx Eqb3MdWhF12GtqvDdcBqx7RHXs292v8+uaGHeg67Wt/2yLu+kaIm+9gbEVD4zaFhY8zF/1 JkhgkQ2zwt+P0MhLmrwCemcUyi7SArEONBHN98CB/4kZy5+0jEa/0VzvMedQJ8df8xGq0t HVcVXhdcdMkdakly5E2y+6NfZ3T8KJCaoOxUnEYpNit5II2NdS1lMVSrvV7TgOsd+XSfx7 d3k4gTgVsJ5cTF20UN4USY24kpFMolSEo6PXbCviG062f/L3xRskplxkh3bvE/M", "action": "delete" }, { "sqs_url": "https://sqs.us-west-2.amazonaws.com/500483111163 /dev-5898ed7fc8e8fa1e23870aff_5a2a6de78e29ae1200ffe0d9", "msg_id": "e36cae8c-5670-47a2-af99-ef4b69b97726", "receipt_handle": "AQEBFZ+d13DrSSVkWE6drLq4naF1YKiMYa9R9UB0UmGtyIJ DBqaocgaNg+BNfQ25c4CcwqDqi7+cUaHFQHa3Uv7yxPcHS1/sYwhbLGxlRYuYe1//t93sc+ 1robi0S18Qt3QVpnSeaEpREGlOZiKYR+yFwLCYOGwtHmZGUL4ltIo9Qrz4XOb+D9TvJpkp0 Szgvc5EAXrDrLkVfgDLHdJVTdeR0T8vW2T6fBzHRMkBKPh+PU8iKfAd1KgJ8zxZM4F4D432 aqCgAtts1/pkPCR7+gubr99EFOv0nQo89fK4O2tQGMvXHzrx05xeArSRLLgoWlI4gvuej6E XirkZrPyA7eKmiI8hBIAIkstDm5Qp2wYxGQyl48IdhV8YERv21dplQebf7qunhQ+biwHoDJ dNzDwNhhsLBDktYcTHixwxb/0h6JnP5nU2Bdr1IjsilpDQQVNZ", "action": "delete" } ]
DeleteMessageResponseBody
Field Name | Type | Description |
|---|---|---|
| array | The message identifiers of the deleted messages |
Sample Response Body
{ "delete": [ "1ad41923-f636-4f1d-bd77-c4923dca16da", "a3bed68a-4b7c-4293-bc6a-43fb4c3c4d1d" ],
DeleteMessageErrorsResponseBody
Field Name | Type | Description |
|---|---|---|
| string | The message identifier of the message our system failed to delete |
| string | Message example: |
| string | The URL of the queue the message was pulled from |
| boolean | The flag that indicates whether an error was received from the main region SQS |
Sample Response Body
"errors": [ { "msg_id": "111ed22b-437c-4293-bc6a-43fb4c10101f", "code": "ReceiptHandleIsInvalid", "sqs_url": "https://sqs.us-east-1.amazonaws.com/500483111163 /dev-5a0ec33aae89b51400620e27_5a0ec33a83f32d1500d5006b", "is_main_source": true } ]