Devices > Incomings

List

get

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/devices/{deviceId}/incomings

Required scope: devices:read

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

deviceIdstringRequired

Query parameters

scopestringOptionalExample: new_sms

pg[sortBy]stringOptional

The value that will be used to sort returned entities by.

pg[offset]integerOptional

The value of entities you want to skip before getting entities you need.

pg[sortDir]string · enumOptional

The sorting order. It accepts the ascending and descending direction specifiers.

Possible values:

pg[limit]integerOptional

Sets the maximum number of results per page in the API call response. For example, pg[limit]=100. The default number varies with different API endpoints.

Responses

200

Successful response

application/json

get

/devices/{deviceId}/incomings

HTTPcURLJavaScriptPython

GET /api/v2/devices/{deviceId}/incomings HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "incomings": [
    {
      "id": "27c4879e5fae4d78b0d371f59187fa93",
      "scope": "new_sms",
      "size": 1,
      "created": "2021-01-26T06:55:58.803Z"
    }
  ],
  "pg": {
    "sortBy": "created",
    "limit": 10000,
    "sortDir": "asc",
    "offset": 0
  }
}

Delete

delete

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/devices/{deviceId}/incomings

"ids" and "all" can no be used together "ids" or "all" has to be set "exceptIds" is possible to use only with "all" It could happen, that some incoming messages are deleted and others not. In this case, the API returns a successful status code, and the response additionally contains an error object with a error description.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

deviceIdstringRequired

Query parameters

confirmedbooleanOptionalExample: true

Body

application/json

idsstring[]Optional

exceptIdsstring[]Optional

allbooleanOptional

Responses

200

Successful response

application/json

delete

/devices/{deviceId}/incomings

HTTPcURLJavaScriptPython

DELETE /api/v2/devices/{deviceId}/incomings HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "ids": [],
  "exceptIds": [],
  "all": true
}

200

Successful response

{
  "incomings": [
    "4ff11b6d24e24fa9add17d11a8143578",
    "167193ab06d34b879346c69aebc8f5c1",
    "d1efa5318a034d36ad7cbeac543573cf",
    "29d9a7410dff494ab739036f6c332335"
  ]
}

Detail

get

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/devices/{deviceId}/incomings/{incomingId}

Required scope: devices:read

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

deviceIdstringRequired

incomingIdstringRequired

Responses

200

Successful response

application/json

get

/devices/{deviceId}/incomings/{incomingId}

HTTPcURLJavaScriptPython

GET /api/v2/devices/{deviceId}/incomings/{incomingId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "id": 5,
  "scope": "text",
  "size": 5,
  "created": "2004-10-19T08:23:54.000Z",
  "data": "text"
}

Stats

get

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/devices/{deviceId}/incomings/stats

Required scope: devices:read

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

deviceIdstringRequired

Query parameters

scopestringOptionalExample: new_sms

Responses

200

Successful response

application/json

get

/devices/{deviceId}/incomings/stats

HTTPcURLJavaScriptPython

GET /api/v2/devices/{deviceId}/incomings/stats HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "incomingStat": {
    "queue": 1,
    "limit": 10000,
    "enabled": true
  }
}