Initiate Driver/Recipient Phone Call
POSThttps://api.uber.com/v1/guests/trips/call
¶ Use case
Use this endpoint to initiate a call between the driver and a recipient. This end-point can be leveraged while the trip is in progress and upon trip completion.
The phone number you provide will be connected with the driver.
The call recipient could be the organization or the rider.
If the request is from a third party (3P) app, please add x-uber-organizationuuid header and the Organization UUID as the value or the request will be denied.
¶ Authorization
OAuth 2.0 Bearer token with the guests.trips
scope.
¶ Request
¶ Example request
curl -X POST \
-H 'authorization: Bearer <access_token>' \
-H 'content-type: application/json' \
-d '{
"request_id": "<request_id>",
"phone_number": "+11234567890"
}' \
'https://api.uber.com/v1/guests/trips/call'
¶ Request body parameters
Field | Type | Description |
---|---|---|
request_id |
string |
A trip’s request unique identified (required). |
phone_number |
string |
The phone number of the recipient to be connected with the driver (required). |
¶ Response
¶ Example response
HTTP 200 OK
¶ Endpoint Possible Errors
HTTP Status | Code | Description |
---|---|---|
400 | validation_failed | This error occurs when an incorrect or invalid request_id/phone_number is provided in the request path. Please use a valid request_id/phone_number to avoid this error. |
401 | unauthorized | Authentication failed. The client lacks valid authentication credentials for the requested resource. |
403 | forbidden | The client does not have permission to access the requested resource. |
404 | not_found | The requested resource or entity could not be found on the server or in the database. |
500 | internal_server_error | An unexpected error occurred on the server while processing the request. |