List or filter all SMS activities

GET

https://api.close.com/api/v1/activity/sms/

GET

/api/v1/activity/sms/

curl https://api.close.com/api/v1/activity/sms/ \
     -u "<CLOSE_API_KEY>:"

{
  "data": [
    {
      "_type": "SMS",
      "activity_at": "2016-10-03T16:06:11.167000+00:00",
      "caller_id_mode": null,
      "caller_id_reason": null,
      "contact_id": "cont_q4xYmlGhA3060dEl0NDJuHRxPMuVjqLn30AFSzh1fRk",
      "cost": "1",
      "created_by": null,
      "date_created": "2016-10-03T16:06:11.167000+00:00",
      "date_scheduled": null,
      "date_sent": null,
      "date_updated": "2016-10-03T16:06:11.167000+00:00",
      "direction": "inbound",
      "error_message": null,
      "id": "acti_12358hIUhaklslYoYSbtozZuUTyB2zO2nhm7iVSpZpp",
      "lead_id": "lead_iuSXNk1x3446ggPVwQS7ynmp8pGRIDieRYiCnuo4yFb",
      "local_country_iso": "US",
      "local_phone": "+16503334444",
      "local_phone_formatted": "+1 650-333-4444",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "remote_country_iso": "US",
      "remote_phone": "+18183004000",
      "remote_phone_formatted": "+1 818-300-4000",
      "source": "Close.io",
      "status": "inbox",
      "template_id": null,
      "text": "SMS in Close? HUZZAH!!!",
      "updated_by": null,
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "users": [],
      "created_by_name": null,
      "updated_by_name": null,
      "user_name": "Tobias Fuenke",
      "attachments": [
        {
          "content_type": "image/png",
          "filename": "media_1.png",
          "media_id": "media_1GnAWzBfs0SOjTDcUnyyP9",
          "size": 15148,
          "thumbnail_url": "https://app.close.com/go/sms/acti_12358hIUhaklslYoYSbtozZuUTyB2zO2nhm7iVSpZpp/media/media_7Ga8l93XLVvqNsgjPbBuUI/thumbnail/",
          "url": "https://app.close.com/go/sms/acti_12358hIUhaklslYoYSbtozZuUTyB2zO2nhm7iVSpZpp/media/media_7Ga8l93XLVvqNsgjPbBuUI/"
        }
      ]
    }
  ],
  "has_more": false
}

Get a list of matching SMS activities.

MMS messages are considered SMS messages with attachments. Attachments have identical fields to email attachments (url, filename, size and content_type), a media_id uniquely identifying an attachment, and if Close was able to generate a thumbnail, a thumbnail_url too.

Accessing url or thumbnail_url requires an authenticated session and leads to a temporarily signed S3 URL.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

_limitintegerOptionalDefaults to 100

Number of results to return.

_skipintegerOptionalDefaults to 0

Number of results to skip before returning, for pagination.

id__inlist of strings or nullOptional

Filter by activity IDs (comma-separated)

lead_idlist of strings or nullOptional

Filter by lead IDs (comma-separated)

contact_idlist of strings or nullOptional

Filter by contact IDs (comma-separated)

user_idlist of strings or nullOptional

Filter by user IDs (comma-separated)

organization_idstring or nullOptional

_typelist of strings or nullOptional

Filter by activity type, e.g. Call (comma-separated)

date_created__gtedatetime or dateOptional

date_created__ltedatetime or dateOptional

date_created__gtdatetime or dateOptional

date_created__ltdatetime or dateOptional

activity_at__gtedatetime or dateOptional

activity_at__ltedatetime or dateOptional

activity_at__gtdatetime or dateOptional

activity_at__ltdatetime or dateOptional

_fieldsstringOptional

Comma-separated list of fields to include in the response.

Response

Successful response

datalist of objects

has_moreboolean

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error