Управление клиентами

Клиент - содержит информацию о пользователе приложения. Добавление клиента осуществляется по клиентскому токену. Клиент содержит информацию о номере телефона и т.п.

Попробуйте в Swagger

Аутентификация

Для всех методов используется аутентификация на основе Bearer токена, который можно получить в личном кабинете

Добавление и изменение клиента

Формат запроса

POST https://api.multipushed.ru/v3/management/customer

Тело запроса:

Добавление клиента

{
  "operation": "Create",
  "clientTokens": [
    "<clientToken1>",
    "<clientToken2>"
  ],
  "phoneNumber": "<phoneNumber>",
  "customFields": "<string>"
}

operation	Create - тип операции	Обязательное поле
clientTokens	Клиентские токены, перечисляются через запятую	Обязательное поле
phoneNumber	Номер телефона в формате 79999999999	Обязательное поле
customFields	Поле для доп информации	Обязательное поле

Изменение телефона либо кастомного поля

{
  "customerId": "<customerId>",
  "operation": "Update",
  "phoneNumber": "<phoneNumber>",
  "customFields": "<string>"
}

customerId	ID изменяемого клиента	Обязательное поле
operation	Update - тип операции	Обязательное поле
phoneNumber	Номер телефона в формате 79999999999	Необязательное поле
customFields	Поле для доп информации	Необязательное поле

Добавление токенов существующему клиенту

{
  "customerId": "<customerId>",
  "operation": "Add",
  "clientTokens": [
    "<clientToken1>",
    "<clientToken2>"
  ]
}

customerId	ID изменяемого клиента	Обязательное поле
operation	Add - тип операции	Обязательное поле
clientTokens	Добавляемые клиентские токены, перечисляются через запятую	Обязательное поле

Удаление токенов

{
  "customerId": "<customerId>",
  "operation": "Remove",
  "clientTokens": [
    "<clientToken1>",
    "<clientToken2>"
  ]
}

customerId	ID изменяемого клиента	Обязательное поле
operation	Remove - тип операции	Обязательное поле
clientTokens	Удаляемые клиентские токены, перечисляются через запятую. Ищутся совпадения по customerId и приложению\вебсайту	Обязательное поле

Удаление клиента

{
  "customerId": "<customerId>",
  "operation": "Delete"
}

customerId	ID удаляемого клиента	Обязательное поле
operation	Delete - тип операции	Обязательное поле

Замена клиента (Старые данные будут удалены и заменены новыми)

{
  "customerId": "<customerId>",
  "operation": "Replace",
  "clientTokens": [
    "<clientToken1>",
    "<clientToken2>"
  ],
  "phoneNumber": "<phoneNumber>",
  "customFields": "<string>"
}

customerId	ID заменяемого клиента	Обязательное поле
operation	Replace - тип операции	Обязательное поле
clientTokens	Клиентские токены, перечисляются через запятую	Обязательное поле
phoneNumber	Номер телефона в формате 79999999999	Обязательное поле
customFields	Поле для доп информации	Необязательное поле

Примеры запроса:

curl https://api.multipushed.ru/v3/management/customer \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: YOUR_SECRET_TOKEN' \
  --data '{
  "operation": "Create",
  "clientTokens": [
    "<clientToken1>",
    "<clientToken2>"
  ],
  "phoneNumber": null,
  "customFields": "<string>"
}'

curl https://api.multipushed.ru/v3/management/customer \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: YOUR_SECRET_TOKEN' \
  --data '{
  "customerId": "<customerId>",
  "operation": "Replace",
  "clientTokens": [
    "<clientToken1>",
    "<clientToken2>"
  ],
  "phoneNumber": "<phoneNumber>",
  "customFields": "<string>"
}'

Пример ответа:

В случае успеха

{
  "success": true,
  "message": null,
  "errCode": null,
  "model": {
    "customer": {
      "id": null,
      "phone": null
    },
    "updatedTokens": [
      "string"
    ],
    "notFoundClientTokens": [
      "string"
    ],
    "suspendedClientTokens": [
      "string"
    ],
    "unauthorizedClientTokens": [
      "string"
    ]
  }
}

customer id	ID клиента, который вы сохраняете на своей стороне
success	результат выполнения запроса
errCode	код ошибки, будет заполнено в случае ошибки
message	текстовое описание ошибки, будет заполнено в случае ошибки

Инфо о клиенте

Формат запроса

GET https://api.multipushed.ru/v2/info/customer

Пример запроса:

curl 'https://api.multipushed.ru/v2/info/customer?customerId=customerId' \
  --header 'Authorization: YOUR_SECRET_TOKEN'

Пример ответа:

В случае успеха

{
  "success": true,
  "message": null,
  "errCode": null,
  "model": {
    "id": null,
    "phone": null,
    "customFields": "<string>",
    "clientTokens": [
      {
        "clientToken": null,
        "createDate": "2025-07-10T13:35:56.386Z",
        "applicationId": null,
        "possibleTransports": [
          "Pushed"
        ],
        "sdkVersion": null,
        "operatingSystem": null,
        "mobileDeviceName": null,
        "backgroundWorkPermission": null,
        "displayPushNotificationsPermission": null,
        "lastUpdateDate": "2025-07-10T13:35:56.386Z"
      }
    ]
  }
}

success	результат выполнения запроса
message	текстовое описание ошибки, будет заполнено в случае ошибки
errCode	код ошибки, будет заполнено в случае ошибки

Выгрузка информации по приостановленным токенам

Формат запроса

POST https://api.multipushed.ru/v2/info/suspended-tokens

Тело запроса:

{
  "customerId": null,
  "dateFrom": null,
  "dateTo": null,
  "limit": 1,
  "offset": 1
}

Параметры тела запроса

customerId	ID редактируемого клиента (Если не указан, будут искаться все привязанные к приложению/вебсайту)	Необязательное поле
dateFrom	Дата приостановки действия токена в формате UTC, от которой осуществляется поиск (если параметр не задан, выгрузка будет от первого сообщения по клиентскому токену)	Необязательное поле
dateTo	Дата приостановки действия токена в формате UTC, до которой осуществляется поиск (если параметр не задан, выгрузка будет до последнего сообщения по клиентскому токену)	Необязательное поле
limit	Количество элементов, которое будет возвращено при запросе (по умолчанию - 100)	Необязательное поле
offset	Смещение при поиске сообщений (по умолчанию - 0)	Необязательное поле

Пример запроса:

curl https://api.multipushed.ru/v2/info/suspended-tokens \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: YOUR_SECRET_TOKEN' \
  --data '{
  "customerId": null,
  "dateFrom": null,
  "dateTo": null,
  "limit": 1,
  "offset": 1
}'

Пример ответа:

В случае успеха

{
  "success": true,
  "message": null,
  "errCode": null,
  "model": {
    "limit": 1,
    "offset": 1,
    "data": [
      {
        "clientToken": null,
        "createDate": "2025-07-10T13:36:04.115Z",
        "applicationId": null,
        "possibleTransports": [
          "Pushed"
        ],
        "sdkVersion": null,
        "operatingSystem": null,
        "mobileDeviceName": null,
        "backgroundWorkPermission": null,
        "displayPushNotificationsPermission": null,
        "lastUpdateDate": "2025-07-10T13:36:04.115Z"
      }
    ]
  }
}

success	результат выполнения запроса
message	текстовое описание ошибки, будет заполнено в случае ошибки
errCode	код ошибки, будет заполнено в случае ошибки