Contact1.3

Add

Description : Adds a new contact, updates an existing contact, or imports/syncs a third-party contact to the current session user's contact list.

Required Parameters:

• session_token : A type 1 or type 2 session token. (Type 2 will require a call signature).

Relative Parameters:

• signature : Required only for session token version 2. Click here to learn more about building an API call signature.

Optional Parameters:

• response_format : 'xml' or 'json' (default 'xml')
• contact_type : Indicates the contact type to be added ("mediafire", "facebook", "gmail", "twitter"...). If not set, then it will be left blank.
• contact_key : Specifies an existing contact. If provided, the specified contact details will be added to this contact. If unset, then a new contact will be created. **IMPORTANT NOTE** 'source_uid' MUST BE SUPPLIED IF USING A CONTACTKEY.
• display_name : The display name of the contact to be added.
• first_name : The first name of the contact to be added.
• last_name : The last name of the contact to be added.
• avatar : The URL to the picture/icon of the contact.
• source_uid : The user ID (MediaFire, Facebook, Twitter...) of the contact to be added.
• email : The email address of the contact to be added.
• phone : The phone number (xxx-xxx-xxxx) of the contact to be added.
• birthdate : The date of birth (yyyy-mm-dd) of the contact to be added.
• location : The location (city, state, country) of the contact to be added.
• gender : The gender of the contact to be added. 1 = female, 2 = male.
• website : The URL of the contact's website.
• response_format : 'xml' or 'json' (default 'xml')

Response Properties

Error Codes

Examples:

http://www.mediafire.com/api/1.3/contact/add.php?session_token=749e4610d9e719620a1e9347ca9aabe5f86ac58d67c8bdd85f0eb4e043624ac70ec1a3f88dd49bb8126ad4c38a7686665ec66d727207ac1a99e9dc6c5cdf0772da405c3464c2d2af&contact_type=mediafire&display_name=TEST4&email=test4@gmail.com
                        

<response>
  <action>contact/add</action>
  <result>Success</result>
  <current_api_version>1.3</current_api_version>
</response>

http://www.mediafire.com/api/contact/add.php?contact_type=mediafire&display_name=TEST4&email=test4@gmail.com&session_token=749e4610d9e719620a1e9347ca9aabe5f86ac58d67c8bdd85f0eb4e043624ac70ec1a3f88dd49bb8126ad4c38a7686665ec66d727207ac1a99e9dc6c5cdf0772da405c3464c2d2af&response_format=json

                        

{
  "response": {
    "action": "contact/add",
    "result": "Success",
    "current_api_version": "1.3"
  }
}

Delete

Description : Delete a contact from the current session user's contact list.

Required Parameters:

• session_token : A type 1 or type 2 session token. (Type 2 will require a call signature).
• contact_key : The key of the contact to be added.

Relative Parameters:

• signature : Required only for session token version 2. Click here to learn more about building an API call signature.

Optional Parameters:

• response_format : 'xml' or 'json' (default 'xml')

Response Properties

Error Codes

Examples

HTTPS://www.mediafire.com/api/contact/delete.php?session_token=&contact_key=8928dog&response_format=json&signature=
                            
                        

{
   action: contact/delete,
   result: Success,
   new_key: yes,
   current_api_version: 1.3,
}

HTTPS://www.mediafire.com/api/contact/delete.php?session_token=&contact_key=8928dog&response_format=xml&signature=

<action>contact/delete</action>
<message>This contact does not exist</message>
<error>138</error>
<result>Error</result>
<new_key>yes</new_key>
<current_api_version>1.3</current_api_version>

Fetch

Description : Returns the contact list (contactkey, display name, first name, last name, avatar, email, phone, means_of_contact, birthdate, location, gender, website, created date, & contact type), revision, and count of the current session user. If method = "autocomplete", the contact list is returned as a trie (radix tree) structure. It is faster to traverse the trie branches using contact names and emails to find contacts. The trie is saved can be returned "raw" or in a "succinct" format. The response will contain the trie (base-64 encoded), the directory (base-64 encoded), and the number of nodes.

Required Parameters:

session_token : A type 1 or type 2 session token. (Type 2 will require a call signature).

Relative Parameters:

• signature : Required only for session token version 2. Click here to learn more about building an API call signature.

Optional Parameters:

• method : The method of getting the contact list. "normal" or "autocomplete" (default "normal"). If this is passed, group_contacts, start, and limit are ignored. "autocomplete" will return a succinct trie by default.
• contact_key : A single contact key or a comma-separated list. When the 'method' is 'normal', only data for these contacts will be returned.
• group_contacts : Specifies whether to return contacts separated into their contact groups. 'yes' or 'no' (default = 'no').
• start : The number of contacts to skip (default = 0).
• limit :The maximum number of contacts to return. If not passed or limit=0, all contacts are returned beyond start. Ignored if method is passed.
• raw : Specifies whether the trie data should be returned in its original (non-succinct) form. 'yes' or 'no' (default = 'no').
• response_format : 'xml' or 'json' (default 'xml')

Response Properties

Error Codes

Examples:

HTTPS://www.mediafire.com/api/contact/fetch.php?session_token=&method=normal&response_format=xml&signature=
                        

<action>contact/fetch</action>
<contact_groups></contact_groups>
<contacts>
   <contact>
      <contact_key>kz8j1r3</contact_key>
      <display_name>Bill Holden</display_name>
      <first_name>Bill</first_name>
      <last_name>Holden</last_name>
      <avatar>https://dev.mediafire.com/images/icons/myfiles/default.png</avatar>
      <email>billh@test.com</email>
      <phone>123-456-7890</phone>
      <source_uid></source_uid>
      <birthdate>1990-01-01</birthdate>
      <location>Somewhere, UT, US</location>
      <gender>male</gender>
      <website></website>
      <options>0</options>
      <created>2015-01-29 17:46:45</created>
      <contact_type>user</contact_type>
   </contact>
   <contact>
      <contact_key>4c4mmb4</contact_key>
      <display_name>Test 02</display_name>
      <first_name>Test</first_name>
      <last_name>02</last_name>
      <avatar>http://www.mediafire.com/images/icons/myfiles/default.png</avatar>
      <email>t02@g.n</email>
      <phone></phone>
      <source_uid>t02@g.n</source_uid>
      <birthdate>0000-00-00</birthdate>
      <location></location>
      <gender>none</gender>
      <website></website>
      <options>1</options>
      <created>2014-10-16 18:23:33</created>
      <contact_type>mediafire</contact_type>
   </contact>
</contacts>
<count>2</count>
<revision>3</revision>
<epoch>1422545796</epoch>
<result>Success</result>
<new_key>yes</new_key>
<current_api_version>1.3</current_api_version>
                        

Get Avatar

Description: Returns the URL of a given contact's avatar image.

Required Parameters:

• session_token : A type 1 or type 2 session token. (Type 2 will require a call signature).
• contact_key : The unique key of the contact whose avatar is to be returned.

Relative Parameters:

• signature : Required only for session token version 2. Click here to learn more about building an API call signature.

Optional Parameters:

• response_format : 'xml' or 'json' (default 'xml')

Response Properties

Error Codes

Examples:

HTTPS://www.mediafire.com/api/contact/get_avatar.php?session_token=&contact_key=4c4mmb4&response_format=json&signature=
                

{
   action: contact/get_avatar,
   avatar: http://dev.mediafire.com/images/icons/myfiles/default.png,
   result: Success,
   new_key: yes,
   current_api_version: 1.3,
}                    

HTTPS://www.mediafire.com/api/contact/get_avatar.php?session_token=&contact_key=4c4mmb5&response_format=json&signature=
                

<action>contact/get_avatar</action>
<message>This user has no associated avatar image</message>
<error>230</error>
<result>Error</result>
<new_key>yes</new_key>
<current_api_version>1.3</current_api_version>

Get Sources

Description: Get contact sources in descending order of precedence.

Required Parameters:

• none

Relative Parameters:

• none

Optional Parameters:

• response_format : 'xml' or 'json' (default 'xml')

Error Codes

Response Properties

Example 1 (Success with JSON):

HTTPS://www.mediafire.com/api/contact/get_sources.php?response_format=json

{
   action: contact/get_sources,
   sources:[
      User,
      MediaFire,
      Facebook,
      Gmail,
      Twitter,
      Tumblr,
   ]
   result: Success,
   current_api_version: 1.3,
}

Set Avatar

Description: Save a copy of a given contact's remote avatar image for use in the operating user's list.

Required Parameters:

• session_token : A type 1 or type 2 session token. (Type 2 will require a call signature).
• contact_key : The unique key of the contact whose avatar is to be returned.
• url : The URL where this image file is located.

Relative Parameters:

• signature : Required only for session token version 2. Click here to learn more about building an API call signature.

Optional Parameters:

• response_format : 'xml' or 'json' (default 'xml')

Response Properties

Error Codes

Examples:

HTTPS://www.mediafire.com/api/contact/set_avatar.php?session_token=&contact_key=kz8j1r3&url=https://lh5.googleusercontent.com/-ER0y8PyG7Zo/AAAAAAAAAAI/AAAAAAAAAEU/NAc8iG47xNc/photo.jpg&response_format=json&signature=
                        

{
   action: contact/set_avatar,
   upload_key: l8k88whcx7,
   result: Success,
   new_key: yes,
   current_api_version: 1.3,
}                        

Example 2 (Failure with JSON - Error 372):

HTTPS://www.mediafire.com/api/contact/set_avatar.php?session_token=&contact_key=kz8j1r3&url=https:/lh5.googleusercontent.com/-ER0y8PyG7Zo/NAc8iG47xNc/photo.jpg&response_format=json&signature=
                        

{
   action: contact/set_avatar,
   message: The URL specified is invalid,
   error: 372,
   result: Error,
   new_key: yes,
   current_api_version: 1.3,
}

Summary

Description : Fetch a summary of contacts by type, including direct vs. indirect.

Required Parameters:

session_token : A type 1 or type 2 session token. (Type 2 will require a call signature).

Relative Parameters:

• signature : Required only for session token version 2. Click here to learn more about building an API call signature.

Optional Parameters:

• response_format : 'xml' or 'json' (default 'xml')

Response Properties

Error Codes

Examples:

HTTPS://www.mediafire.com/api/contact/summary.php?session_token=&response_format=xml&signature=

<action>contact/summary</action>
<direct>112</direct>
<indirect>240</indirect>
<user>2</user>
<mediafire>254</mediafire>
<facebook>88</facebook>
<gmail>8</gmail>
<twitter>0</twitter>
<sms>0</sms>
<tumblr>0</tumblr>
<result>Success</result>
<new_key>yes</new_key>
<current_api_version>1.3</current_api_version>