5.1. Get courier's phone number

  1. HTTP Request
  2. Request Body
    1. Representation
    2. Fields
  3. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 400
      1. Representation
      2. Fields
    3. Code 404
      1. Representation
      2. Fields
    4. Code 409
      1. Representation
      2. Fields
  4. Example

Returns the phone number to call the driver who is
currently executing the claim.

HTTP Request

POST b2b.taxi.yandex.net/b2b/cargo/integration/v2/driver-voiceforwarding

Request Body

{
  "claim_id": string,
  "point_id": integer
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

claim_id *

string

Claim ID, received upon creation of claim

point_id

integer

The integer ID (int64) of the point generated by Delivery.
Contained in the route_points[].id. Applicable to points with the following types:

source, destination, return

claim_id *

string

Claim ID, received upon creation of claim

point_id

integer

The integer ID (int64) of the point generated by Delivery.
Contained in the route_points[].id. Applicable to points with the following types:

source, destination, return

Responses

Code 200

OK

{
  "ext": string,
  "phone": string,
  "ttl_seconds": integer
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

ext *

string

Extension

phone *

string

Phone number

ttl_seconds *

integer

Time during which this number is valid (int64)

ext *

string

Extension

phone *

string

Phone number

ttl_seconds *

integer

Time during which this number is valid (int64)

Code 400

Blank phone number

{
  "code": string,
  "message": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. invalid_point_phone

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. invalid_point_phone

message *

string

Human-readable error message

Code 404

Claim or order performer not found

{
  "code": string,
  "message": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. not_found

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. not_found

message *

string

Human-readable error message

Code 409

Order completed.

{
  "code": string,
  "message": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. inappropriate_status

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. inappropriate_status

message *

string

Human-readable error message

Example

Request:

curl -X POST "b2b.taxi.yandex.net/b2b/cargo/integration/v2/driver-voiceforwarding" \
-d '{
  "point_id": 6987
}'
Copied to clipboard

Responses:

{
  "ext": "0163",
  "phone": "+79099999998",
  "ttl_seconds": 2088
}
Copied to clipboard