HTTP request
GET https://api.wevoteusa.org/apis/v1/voterSMSPhoneNumberRetrieve (Jump to "Try It Now")
Required Parameters
Parameter name | Value | Description |
api_key | string (from post, cookie, or get (in that order)) | The unique key provided to any organization using the WeVoteServer APIs |
voter_device_id | string | An 88 character unique identifier linked to a voter record on the server |
Response
{ "status": string, "success": boolean, "voter_device_id": string (88 characters long), "sms_phone_number_list_found": boolean, "sms_phone_number_list": list [ "normalized_sms_phone_number": string, "primary_sms_phone_number": boolean, "sms_permanent_bounce": boolean, "sms_ownership_is_verified": boolean, "voter_we_vote_id": string, "sms_we_vote_id": string, ], }
Response Status Codes
Code | Description |
VALID_VOTER_DEVICE_ID_MISSING | A valid voter_device_id parameter was not included. Cannot proceed. |
VOTER_NOT_FOUND_FROM_VOTER_DEVICE_ID | No voter could be found from the voter_device_id |
Try It Now: API Variables
Retrieve a list of all the sms phone numbers for voter using voter_device_id.