Last 7 days, UTC

Average Latency
73ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time
Query Authentication
 

simple id + token authentication


Authentication
Description
Parameter
String

client_id is your account id

client_id

Required

String

your secret API token

token

Required

Endpoints

HTTP 200 : string POST/cm/list.append
list.append

Add numbers to your list.


Test console
Description
Parameter
string

Id of the list to update.
Example: 12332

list_id

Required

string

List of phone numbers to append.
Example: 3104323098,3104323093,3104324098

numbers

Required

string

specify response format (xml by default)
Example: json

format

Optional

HTTP 200 : string POST/cm/list.create
list.create

Create a list of mobile numbers.


Test console
Description
Parameter
string

Example: IOS users list

name

Required

string

specify json format (xml by default)
Example: json

format

Optional

HTTP 200 : string GET/cm/list.destroy
list.destroy

Destroy a list completely.


Test console
Description
Parameter
string

id of the list to destroy
Example: 32423

list_id

Required

string

name of the list to destroy (additional security)
Example: IOS users list

name

Required

string

specify response format (xml by default)
Example: json

format

Required

HTTP 200 : string GET/cm/list.download
list.download

Download a list of numbers.


Test console
Description
Parameter
string

Id of the list to download.

list_id

Required

string

format of the response (xml by default)
Example: csv or json

format

Optional

HTTP 200 : string POST/cm/list.empty
list.empty

Erase a list.


Test console
Description
Parameter
string

id of the list to erase
Example: 324243

list_id

Required

string

Name of the list to erase (additional security)
Example: IOS users list

name

Required

string

specify response format (xml by default)
Example: json

format

Required

HTTP 200 : string POST/cm/list.prune
list.prune

Remove number from a list.


Test console
Description
Parameter
string

Id of the list to update.
Example: 12332

list_id

Required

string

List of phone numbers to remove.
Example: 3104323098,3104323093

numbers

Required

string

specify response format (xml by default)
Example: json

format

Optional

HTTP 200 : string POST/cm/list.send
list.send

Send a blast of messages to a list of users.


Test console
Description
Parameter
string

Id of the list to use.
Example: 12332

list_id

Required

string

Either your sms or mms_campaign_id.
Example: 34532

campaign_id

Required

string

Body of the text message
Example: Hello world

message

Required

string

For MMS: content_id of a media already ingested with the media.upload API
Example: 4343

content_id

Optional

string

For MMS: url of an image, video or audio.
Example: http://i47.tinypic.com/14dkeio.jpg

content_url

Required

string

specify response format (xml by default)
Example: json

format

Required

HTTP 200 : string GET/cm/media.get
media.get

Lookup a single media object by id.


Test console
Description
Parameter
string

id of a previously uploaded content.
Example: 213123

content_id

Required

string

specify json format (xml by default)
Example: json

format

Optional

HTTP 200 : string GET/cm/media.list
media.list

List all the media you have previously uploaded.


Test console
Description
Parameter
string

specify json format (xml by default)
Example: json

format

Optional

HTTP 200 : media.upload POST/cm/media.upload
Success upload response
						{
  "response": {
    "code": "1",
    "status": "success",
    "message": "media correctly uploaded",
    "media": {
      "name": "My Cat",
      "content_id": "212778",
      "smart_url": "http://m.mogreet.com/oc/jxc304oah"
    }
  }
}						
media.upload

Upload image, video or audio files to Mogreet


Test console
Description
Parameter
string

Image, audio or video are the 3 media types.
Example: image

type

Required

string

Name you want to give to this media
Example: image of a cat

name

Required

binary

Raw file posted as multi-part form data
Example: @my_cat.jpeg

file

Required

string

You can provide an url instead of posting a file.
Example: http://i47.tinypic.com/14dkeio.jpg

url

Optional

string

webhook to receive update when ingestion and transcodes are complete.
Example: http://myapp.herokuapp.com/uploads

callback_url

Optional

string

specify json format (xml by default)
Example: json

format

Required

HTTP 200 : string GET/moms/system.ping
system.ping

Test your credentials and our system status.


Test console
Description
Parameter
string

specify json format (xml by default)
Example: json

format

Required

HTTP 200 : transaction.send POST/moms/transaction.send
Successful message send response
						{
  "response": {
    "code": "1",
    "status": "success",
    "message": "API Request Accepted",
    "message_id": "151652220",
    "hash": "bfjuyob6"
  }
}						
transaction.send

main api endpoint


Test console
Description
Parameter
string

The sms or mms campaign id visible in your dashboard
Example: 43123

campaign_id

Required

string

The destination mobile number
Example: 21323452345

to

Required

string

Body of the text message
Example: Hello world

message

Required

string

For MMS: url of an image, video or audio.
Example: http://i47.tinypic.com/14dkeio.jpg

content_url

Optional

string

For MMS: content_id of a media already ingested with the media.upload API
Example: 5234

content_id

Optional

string

optionnal webhook to receive status on the message delivery to carriers
Example: http://myapp.herokuapp.com/status

callback

Optional

string

adds the following text to the message: "message from 21398709870:"
Example: 21398709870

from

Optional

string

specify json format (xml by default)
Example: json

format

Optional

  • string

    HTTP 0
HTTP 200 : string GET/moms/user.lookup
user.lookup

Get information on a phone number


Test console
Description
Parameter
string

phone number to lookup
Example: 3104857839

number

Required

string

specify response format (xml by default)
Example: json

format

Required

Consume this API completely for free!


By joining the mashape API marketplace you can start using Mogreet API today!

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.