NewsMAN API: sms.getByTelephone

Sections

Newsman – Knowledge Base

HomeAPISmssms.getByTelephone

Newsman Api Method: sms.getByTelephone

Prototype: sms.getByTelephone(list_id, telephone)

Description: Returns subscriber data as hash (struct) array

HTTP method: GET

Endpoint HTTP: /subscriber.getByTelephone.json

Endpoint XML-RPC: subscriber.getByTelephone

Return type: struct

Return info: Hash array with subscriber details:
subscriber_id
telephone
status: any of subscribed, unsubscribed, bounced, spam, inactivated
subscribe_date: present if subscribed
unsubscribe_date: present if unsubscribed
bounce_date: present if bounced
spam_date: present if spam complaint received
firstname
lastname
ip
props: hash array with props stored for this subscriber

Request parameters GET

Variable	Type	Description
list_id	string\|int	The ID of the list in which to search the subscriber
telephone	string	The telephone number of the subscriber

Response parameters

Parameter	Description
list_id	The ID of the list of the subscriber
subscriber_id	The ID of the subscriber
telephone	The telephone of the subscriber
status	The status: any of subscribed, unsubscribed, bounced, spam, inactivated
subscribe_date	The date of subscription. Present if subscribed.
unsubscribe_date	The date of unsubscription. Present if unsubscribed.
bounce_date	The date of the bounce. Present if bounced.
spam_date	The date of the spam report. Present if spam complaint received
firstname	The firstname of the subscriber
lastname	The lastname of the subscriber
ip	The ip of the subsscription
props	Hash array with props stored for this subscriber
segments	Hash array with the segments that includ this subscriber

Output example

{
    "list_id": "my_list_id",
    "subscriber_id": 75001,
    "telephone": "testNumber",
    "status": "subscribed",
    "subscription_type": "import",
    "subscribe_date": "2018-05-13 17:02:32",
    "firstname": null,
    "lastname": null,
    "ip": "127.0.0.1",
    "props": [],
    "segments": [
        {
            "segment_id": 15002,
            "name": "my_segment_name"
        }
    ]
}

Response Errors

Code	Message	Description
407	Missing required param list_id	list_id param is required
407	Missing required param telephone	telephone param is required
101	Not allowed for list_id = %s	Invalid access to subscriber list_id
108	List %s has been deleted	List ID belongs to a list which has been deleted
123	Invalid telephone number %s	The telephone of the subscriber is invalid
121	Could not load subscriber	The subscriber was not found

Error examples

{
    "err": true,
    "message": "Missing required param list_id",
    "code": 407
}

{
    "err": true,
    "message": "Missing required param telephone",
    "code": 407
}

{
    "err": true,
    "message": "Invalid telephone number 'invalidphone'.",
    "code": 123
}

{
    "err": true,
    "message": "Could not load subscriber",
    "code": 121
}