POST api/hlr/validation

Get mobile validation (synchronous). Limit: 360 requests per minute.

Request Information

Header Description

Key	Value	Information
Authorization	Bearer access_token	The access_token is retrieved by the authentication method.

Body Parameters

sat.WebServices.Models.Hlr.ValidationRequest

Name	Description	Type	Additional information
Mobile	Phone number	string	Required
Pays	Country Code (ISO2, ISO3, Full ('FR', 'Fra', 'France')	string	None.
Timeout	Time before expiration of demand (in ms)	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Mobile": "sample string 1",
  "Pays": "sample string 2",
  "Timeout": 3
}

application/xml, text/xml

Sample:

<ValidationRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Mobile>sample string 1</Mobile>
  <Pays>sample string 2</Pays>
  <Timeout>3</Timeout>
</ValidationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

sat.WebServices.Models.Hlr.ResultatResponse

Name	Description	Type	Additional information
Message	Message related to the return code	string	None.
Code	Return code	string	None.
CampagneId	Campaign identifier	string	None.
Mobile	Mobile phone	string	None.
Operateur	Current telephone operator	string	None.
Statut	Active / Inactive / Unknown	string	None.
IsPorted	Lets you know if the number has undergone portability	boolean	None.
IsRoaming	Lets you know if the number is currently in roaming via the network of a mobile operator other than his own	boolean	None.
Pays	Country	string	None.
OperateurOrigine	Original telephone operator	string	None.
CodeErreur	Additional information concerning the network status	string	None.
TypeTelephone	F: landline, M: mobile, I: not identified	string	None.
IsTrancheAttribuee	Is part of the list of allocated telephone numbering resources (6 digits)	boolean	None.
Territoire	Territory in which the numbering range was allocated (6 digits)	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "Code": "sample string 2",
  "CampagneId": "sample string 3",
  "Mobile": "sample string 4",
  "Operateur": "sample string 5",
  "Statut": "sample string 6",
  "IsPorted": true,
  "IsRoaming": true,
  "Pays": "sample string 9",
  "OperateurOrigine": "sample string 10",
  "CodeErreur": "sample string 11",
  "TypeTelephone": "sample string 12",
  "IsTrancheAttribuee": true,
  "Territoire": "sample string 13"
}

application/xml, text/xml

Sample:

<ResultatResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Message>sample string 1</Message>
  <Code>sample string 2</Code>
  <CampagneId>sample string 3</CampagneId>
  <Mobile>sample string 4</Mobile>
  <Operateur>sample string 5</Operateur>
  <Statut>sample string 6</Statut>
  <IsPorted>true</IsPorted>
  <IsRoaming>true</IsRoaming>
  <Pays>sample string 9</Pays>
  <OperateurOrigine>sample string 10</OperateurOrigine>
  <CodeErreur>sample string 11</CodeErreur>
  <TypeTelephone>sample string 12</TypeTelephone>
  <IsTrancheAttribuee>true</IsTrancheAttribuee>
  <Territoire>sample string 13</Territoire>
</ResultatResponse>