API REFERENCEv1

View Group

GEThttps://api2.protexting.com/v1/groups/view

⌘

Pass your server-side token as access_token. Replace sample values with your own. Authentication & setup →

Request parameters:

Parameter	Description
id	Group Id

Response parameters:

Parameter	Description
Id	Group Id
Name	Group name, string, characters count between 3 and 255 symbols
Note	Keyword Id, int, if equals to 0 means the group is not a keyword group, otherwise the group is attached to a keyword.
KeywordId	Parent Group Id, int, if equals to 0 means the group is a parent group, otherwise the group is a child group which parent group Id is ParentId.
ParentId	Parent Group Id, int, if equals to 0 means the group is a parent group, otherwise the group is a child group which parent group Id is ParentId.
DateCreated	The date when the record was created, string.
DateUpdated	The date when the record was updated, string.
PhoneNumberIds	PhoneNumber Ids, array of integers, the Ids of Phone Numbers in the group

Example Request:

Request example

1# Set PROTEXTING_ACCESS_TOKEN in your environment2curl --request GET \3  "https://api2.protexting.com/v1/groups/view?id=1&access_token=${PROTEXTING_ACCESS_TOKEN:?Set your API token}" \4  --header 'Accept: application/json'

Server-side exampleJSON · HTTPS

Example Response Headers:

Response headers example

1Status Code: 200 OK2 Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=03 Connection: Keep-Alive4 Content-Length: 2725 Content-Type: application/xml; charset=utf-86 Keep-Alive: timeout=5, max=1007 Pragma: no-cache8 X-Powered-By: PHP/5.6.29 X-Rate-Limit-Limit: 6010 X-Rate-Limit-Remaining: 5911 X-Rate-Limit-Reset: 0

Example Response Body:

JSON response example

1{
2        "Id": 1,
3        "Name": "Sweeps winners from Feb 1, 2015",
4        "Note": "Reminder: Send message to all members of the group to tell them they're winners",
5        "KeywordId": 0,
6        "ParentId": 0,
7        "DateCreated": "2015-01-20 10:21:29",
8        "DateUpdated": "2015-01-20 10:41:29",
9        "PhoneNumberIds": [1,2]
10}

XML response example

1<response>2   <item>3      <Id>1</Id>4      <Name>Sweeps winners from Feb 1, 2015</Name>5      <Note>Reminder: Send message to all members of the group to tell them they're winners</Note>6      <KeywordId>0</KeywordId>7      <ParentId>0</ParentId>8      <DateCreated>2015-01-20 10:21:29</DateCreated>9      <DateUpdated>2015-01-20 10:41:29</DateUpdated>10      <PhoneNumberIds>11         <item>1</item>12         <item>2</item>13      </PhoneNumberIds>14   </item>15</response>

HTTP Status Codes:

The standard HTTP Status Codes are used. More information is available here: http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Error Codes:

Error Codes and Examples here »

← PreviousList Groups Next →Create Group

Reference from the ProTexting documentation catalog. Code examples are illustrative; this page does not execute API requests.