Authenticating with the Zipwhip API

In order to interact with the Zipwhip API, you must first authenticate using the user/login API to generate a session key. You only need to do this once. The session key that is returned uniquely identifies the user and landline phone number and must be used to authenticate all other API requests.

To authenticate, send a POST request to https://api.zipwhip.com/user/login with your username and password as body parameters. You will receive a JSON response with the session key in the response parameter.

Parameters

Key Description
username The username is a combination of a personal prefix plus the phone number separated by an @ sign (e.g. scott@5556661234). Note: US Domestic numbers are 10 digit numbers (e.g. 2061234567) while International numbers must be in E.164 format (e.g. +12061234567).
password Password associated with Zipwhip enabled phone number.

Try it

You can test the user/login method by entering your Zipwhip username and password in the fields below and clicking Submit. Your request will be sent to the server and a JSON response will be displayed below.

View on Codepen

Response

                          
                          
                        

Sample Request

Send a POST request to https://api.zipwhip.com/user/login with your username and password as body parameters.

                      
                        $ curl --location --request POST 'https://api.zipwhip.com/user/login' \
                          --header 'Content-Type: application/x-www-form-urlencoded' \
                          --data-urlencode 'username={{username}}' \
                          --data-urlencode 'password={{password}}'
                      
                    

View on Codepen

Sample Response

A successful request will result in a JSON response with the session key in the response parameter:

                  
                    {
                      "success": true,
                      "response": "d4c68682-95df-41c9-a268-5a54e3b6ccd6:377265507",
                      "sessions": null
                    }