Check a number
Asks the messenger of a channel whether a phone number has an account there. Nothing is
sent. Messenger channels only; other channels answer 422 probe_not_supported.
Authorization
personalToken Your personal access token from Profile → Access Token in Lalexi. It acts with exactly your role: what you may see and do in the workspace, and nothing more. Everything done with it is recorded as done by you.
In: header
Query Parameters
A messenger channel you work in.
The number, in any formatting; on Telegram channels also a @username.
Header Parameters
The workspace to work in (an id from GET /me). Optional when you belong to a single
workspace; required otherwise (400 workspace_required).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://app.lalexi.com/v1/dialogs/probe?channel_id=0&phone=%2B79001234567" \ -H "X-Workspace-Id: 7"{
"status": "found",
"phone": "string",
"name": "string"
}{
"error": {
"code": "workspace_required",
"message": "You belong to several workspaces: pass the X-Workspace-Id header."
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key is missing or invalid."
}
}{
"error": {
"code": "forbidden",
"message": "You are not allowed to do this."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found."
}
}{
"error": {
"code": "invalid_json",
"message": "string",
"details": {}
}
}{
"error": {
"code": "invalid_json",
"message": "string",
"details": {}
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the number of seconds in Retry-After."
}
}{
"error": {
"code": "internal_error",
"message": "Something went wrong on our side."
}
}{
"error": {
"code": "upstream_unavailable",
"message": "The messaging service is unavailable. Nothing was sent; try again."
}
}