Method: GetCustomerInfo

Method Type: Post

This method will be called by your application to look up the information of a given mobile number from the store you request within your auth string. It can be used to recall all information that we store including first and last name. But most importantly it will return the opt-in status of the given mobile number. It can be used to build search functionality into your application.

The CRM Text SMS API has four Customer statuses. They are:

New Guest
The Customer has never before been asked to opt-in to that store. In the CRM Text platform this would be considered customer type “1”.

Opted-In
The Customer has successfully opted-in and can receive messages. In the CRM Text platform this would be considered customer type “3”.

Opted-Out
The Customer has successfully opted-out and will not get any further messages until opting back in. In the CRM Text platform this would be considered customer type “5”.

Pending
The Customer received the opt-in request but has not yet replied YES to the message. In the CRM Text platform this would be considered customer type “2”.

  Restrictions


  • We ask for and require that you send us Customer phone numbers as 10 digits only. (Example: 9995551234)

  Suggestions


  • Use this method to build customer opt-in status search functionality into your application

Request Example

Get Opt-In Status for a Mobile Number:
https://restapi.crmtext.com/smapi/rest?method=getcustomerinfo&phone_number=


Request Parameters

Name Required Value Description
phone_number Yes integer 10 digit mobile number. (Example: 9995551234)

XML Sample Successful Response

1
2
3
4
5
6
7
8
9
10
11
<response op= "getcustomerinfo" status= "200" message= "ok">
<customer>
<totalMsg>2</totalMsg>
<custId>4321</custId>
<custName>John Queue</custName>
<timestamp>2014-08-11 14:23:36</timestamp>
<optinsStatus>3</optinStatus>
<custMobile>9993338888</custMobile>
<subacct>The Awesome Store</subacct>
</customer>
</response>

XML Sample Error Response

1
2
<response op= "getcustomerinfo" status= "4xx" message= "reason for Error">
</response>