Three lines

Uber

Developers

Get Guest Phone Info

GEThttps://api.uber.com/v1/health/guests/phone-info

Privileged and Confidential This endpoint design has been confidentially shared with you. It is still under development and is subject to change without notice. Please do not share this document or API endpoint details with anyone who is not authorized to have access. For more information read about scopes.

Use case

Use this endpoint to retrieve information about a phone number and to know if a health user has unsubscribed to receive Uber messages.

sms_opt_in_number is recommended to be consumed and to let the SMS-unsubscribed riders know what is the phone number to resubscribe.

Authorization

OAuth 2.0 Bearer token with the health scope.

Request
Example request
curl -X GET \
  -H "authorization: Bearer $UBER_TOKEN" \
  'https://api.uber.com/v1/health/guests/phone-info?phone_number=%2B12025556666'
Query Parameters
Name Type Description
phone_number string URL Encoded phone number of a user in E.164 format (international) format (required)
Response Parameters
Name Type Description
is_mobile boolean true if the phone number provided is a mobile number.
is_unsubscribed_sms boolean true if the phone number has unsubscribed from Uber SMS messaging
sms_opt_in_number string phone number for the user to opt-in and to subscribe Uber SMS messaging
message string instructions about how to opt-in and receive Uber SMS messages

sms_opt_in_number field is country-based and possible values are:

  • US: ‘4253104746’ (default)
Response
Example response
{
    "is_mobile": true,
    "is_unsubscribed_sms": true,
    "sms_opt_in_number": "4253104746",
    "message": "We can’t send text message notifications for this ride because the rider opted out of SMS updates. Ask the rider to text START to 4152370403 so we can send ride notifications."
}
Example response - user subscribed
{
    "is_mobile": true,
    "is_unsubscribed_sms": false,
    "sms_opt_in_number": "4253104746"
}

Uber

Developers
© 2023 Uber Technologies Inc.