SmsGetProfiles¶

GET sms/providerProfiles/list

Returns the provider profiles of the brand with the provider name joined in. This is the administration list — for the picker a manager sees, use SmsGetMyProfiles.

Access Control¶

Allowed role: admin, within the brand of the caller.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/sms/providerProfiles/list?limit=50&orderBy=%5B%22routingPriority%22%2C%22ASC%22%5D
Authorization: <JWT_TOKEN>

{
  "command": "SmsGetProfiles",
  "extID": "1",
  "data": {
    "limit": 50,
    "orderBy": [
      "routingPriority",
      "ASC"
    ]
  }
}

const res = await platform.SmsGetProfiles({
  limit: 50,
  orderBy: [
    "routingPriority",
    "ASC"
  ]
});

Request Data¶

Field	Type	Required	Description
`limit`	int	No	Page size, `1..1000`, default `100`
`offset`	int	No	Rows to skip
`orderBy`	array	No	Sorting, for example `["id", "DESC"]`
`count`	array	No	Row count aggregate, `["id"]`
`where`	object	No	Filters, see Table filter syntax

Response Data¶

{
  "rows": [
    {
      "id": 3,
      "brand": "default",
      "providerId": 1,
      "providerName": "twilio",
      "name": "Twilio main",
      "mode": "COMMON",
      "deliveryUpdateBy": "WEBHOOK",
      "credentials": { "accountSid": "AC...", "fromNumber": "+15550001111" },
      "senderId": "ScaleTrade",
      "allowedCountries": ["UA", "PL"],
      "blockedCountries": null,
      "routingPriority": 100,
      "isDefault": true,
      "status": "ENABLED"
    }
  ]
}

Errors¶

Code	Error	Description
`401`	`PERMISSION_DENIED`	Not an admin session