POST api/bitrix24/ContactCheckPhone

Проверка существования контакта по номеру телефона из БД mloyalty в Битрикс24

Request Information

URI Parameters

None.

Body Parameters

ContactCheckPhoneRequest
NameDescriptionTypeAdditional information
ApiURL

Адрес метода Bitrix24, который нужно вызвать

string

None.

Phone

Номер телефона строкой

string

None.

Operator

Идентификатор оператора программы лояльности

integer

None.

Token

Токен пользователя, который инициирует данный запрос

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ApiURL": "sample string 1",
  "Phone": "sample string 2",
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample:
<ContactCheckPhoneRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.Bitrix24Request">
  <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 3</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ApiURL>sample string 1</ApiURL>
  <Phone>sample string 2</Phone>
</ContactCheckPhoneRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ContactCheckPhoneResponse
NameDescriptionTypeAdditional information
Id

Идентификатор первого найденного контакта, строка

string

None.

Total

Количество контактов, которое было найдено номеру телефона

integer

None.

ErrorCode

Код ошибки

integer

None.

Message

Сообщение об ошибке

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Total": 2,
  "ErrorCode": 3,
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:
<ContactCheckPhoneResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.Bitrix24Response">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">3</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 4</Message>
  <Id>sample string 1</Id>
  <Total>2</Total>
</ContactCheckPhoneResponse>