Exchange an authorization code for an access token.

If you are implementing user authentication, the code is generated from a Facebook endpoint which is outside of the Graph API. Please see the Manually Build a Login Flow documentation for more details.

Examples

iex> Facebook.access_token("client_id", "client_secret", "redirect_uri", "code")
{:ok, %{
  "access_token" => access_token,
  "expires_in" => 5183976,
  "token_type" => "bearer"
}}

See: https://developers.facebook.com/docs/facebook-login/manually-build-a-login-flow#confirm

Returns metadata about a given access token.

This includes data such as the user for which the token was issued, whether the token is still valid, when it expires, and what permissions the app has for the given user.

This may be used to programatically debug issues with large sets of access tokens.

An app access token or an app developer's user access token for the app associated with the input_token is required to acces.

See:

• https://developers.facebook.com/docs/graph-api/reference/v2.11/debug_token
• https://developers.facebook.com/docs/facebook-login/manually-build-a-login-flow#checktoken

Examples

iex> Facebook.debug_token("INPUT_TOKEN", "ACCESS_TOKEN")
{:ok, %{"data" => [
  %{
    "app_id": "APP_ID",
    "type": "USER",
    "application": "APP_NAME",
    "expires_at": 1352419328,
    "is_valid": true,
    "issued_at": 1347235328,
    "scopes": [
        "email",
        "publish_actions"
    ],
    "user_id": "USER_ID"
  }
]}

Decodes a signed request from a client SDK (in-app payments), verifies the signature and (if it is valid) returns its decoded contents.

Get the count of fans for the provided page_id/0

Example

iex> Facebook.fan_count("CocaColaMx", "<Access Token>")
{:ok, %{"fan_count" => fan_count, "id" => id}}

See: https://developers.facebook.com/docs/graph-api/reference/page/

Basic Graph object information by object ID

Example

iex> Facebook.get_object("1234567", "<Access Token>")
{:ok, %{"id" => id}}

Get Graph object information for the specified params for the provided object ID

Example

iex> Facebook.get_object("1234567", "<Access Token>", [fields: "id,name"])
{:ok, %{"id" => id, "name" => name}

See: https://developers.facebook.com/docs/graph-api/reference/page

Gets an object edge for a specific object ID

Examples

iex> Facebook.get_object_edge(:adlabels, "act_12345", "<Access Token>")
iex> Facebook.page_feed(:leads, "1223344332", "<Access Token>", [fields: "created_time,id,ad_id,form_id,field_data"])
{:ok, %{"data" => [...]}}

Exchange a short lived access token for a long lived one

Examples

iex> Facebook.long_lived_access_token("client_id", "client_secret", "access_token")
{:ok, %{
  "access_token" => access_token,
  "expires_in" => 5183976,
  "token_type" => "bearer"
}}

See: https://developers.facebook.com/docs/facebook-login/access-tokens/expiration-and-extension

Basic user infos of the logged in user specified by the access_token/0

Examples

iex> Facebook.me("id,first_name", "<Access Token>")
{:ok, %{"first_name" => "...", "id" => "..."}}

iex> Facebook.me([fields: "id,first_name"], "<Access Token>")
{:ok, %{"first_name" => "...", "id" => "..."}}

See: https://developers.facebook.com/docs/graph-api/reference/user/

Accounts for the logged in user specified by the access_token/0

Examples

iex> Facebook.my_accounts("<Access Token>")
{:ok, %{"data" => [...]}}

See: https://developers.facebook.com/docs/graph-api/reference/user/accounts

Likes of the currently logged in user specified by the access_token/0

Example

iex> Facebook.my_likes("<Access Token>")
{:ok, %{"data" => [...]}}

See: https://developers.facebook.com/docs/graph-api/reference/user/likes

Gets the number of elements that a scope has in a given object.

An object stands for: post, comment, link, status update, photo.

If you want to get the likes of a page, please see fan_count/2.

Expected scopes:

• :likes
• :comments

Example

iex> Facebook.object_count(:likes, "1326382730725053_1326476257382367", "<Access Token>")
{:ok, 10}
iex> Facebook.object_count(:comments, "1326382730725053_1326476257382367", "<Access Token>")
{:ok, 5}

See:

• https://developers.facebook.com/docs/graph-api/reference/object/likes
• https://developers.facebook.com/docs/graph-api/reference/object/comments

Gets the number of reactions that an object has.

Expected react_type/0:

• :haha
• :wow
• :thankful
• :sad
• :angry
• :love
• :none

Examples

iex> Facebook.object_count(
  :reaction,
  :wow,
  "769860109692136_1173416799336463",
  "<Access Token>"
)
{:ok, 100}

Get all the object reactions with single request.

Examples

iex> Facebook.object_count_all("769860109692136_1173416799336463", "<Access Token>")
{:ok, %{"angry" => 0, "haha" => 1, "like" => 0, "love" => 0, "sad" => 0, "wow" => 0}}

Basic page information for the provided page_id/0

Example

iex> Facebook.page("CocaColaMx", "<Access Token>")
{:ok, %{"id" => id, "name" => name}}

See: https://developers.facebook.com/docs/graph-api/reference/page

Get page information for the specified fields for the provided page_id/0

Example

iex> Facebook.page("CocaColaMx", "<Access Token>", "id")
{:ok, %{"id" => id}

See: https://developers.facebook.com/docs/graph-api/reference/page

Gets the feed of posts (including status updates) and links published by this page, or by others on this page.

This function can retrieve four scope/0 types:

• :feed
• :posts
• :promotable_posts (Admin permission needed)
• :tagged

A scope/0 must be provided. It is an atom, which represents the type of feed.

A limit of posts may be given. The maximum number that must be provided is 100.

Examples

iex> Facebook.page_feed(:posts, "CocaColaMx", "<Access Token>")
iex> Facebook.page_feed(:tagged, "CocaColaMx", "<Access Token>", 55)
iex> Facebook.page_feed(:promotable_posts, "CocaColaMx", "<Access Token>")
iex> Facebook.page_feed(:feed, "CocaColaMx", "<Access Token>", 55, "id,name")
{:ok, %{"data" => [...]}}

See: https://developers.facebook.com/docs/graph-api/reference/page/feed

Gets payment info about a single payment.

Examples

iex> Facebook.payment("769860109692136", "<App Access Token>", "id,request_id,actions")
{:ok, %{"request_id" => "abc2387238", "id" => "116397053038597", "actions" => [ %{ "type" => "charge", ... } ] } }

See:

• https://developers.facebook.com/docs/graph-api/reference/payment

Settle a payment dispute.

Examples

iex> Facebook.payment_dispute("769860109692136", "<App Access Token>", :DENIED_REFUND)
{:ok, %{"success" => true}}

See:

• https://developers.facebook.com/docs/graph-api/reference/payment/dispute

Refund a payment.

Examples

iex> Facebook.payment_refunds("769860109692136", "<App Access Token>", "EUR", 10.99, :CUSTOMER_SERVICE)
{:ok, %{"success" => true}}

See:

• https://developers.facebook.com/docs/graph-api/reference/payment/refunds

Retrieves a list of granted permissions

Example

iex> Facebook.permissions("<Some Id>", "<Access Token>")
{:ok, %{"data" => [%{"permission" => "...", "status" => "..."}]}}

See: https://developers.facebook.com/docs/graph-api/reference/user/permissions

A Picture for a Facebook User

type may be:

• "small"
• "normal"
• "album"
• "large"
• "square"

Example

iex> Facebook.picture("<Some Id>", "small", "<Access Token>")
{:ok, %{"data": "..."}}

See: https://developers.facebook.com/docs/graph-api/reference/user/picture/

A Picture for a Facebook User with custom dimensions

Example

iex> Facebook.picture("<Some Id>", 480, 480, "<Access Token>")
{:ok, %{"data": "..."}}

See: https://developers.facebook.com/docs/graph-api/reference/user/picture/

Publish to a graph edge using the supplied token. Publish to a feed. Author (user or page) is determined from the supplied token.

The page_id/0 is the id for the user or page feed to publish to. Apps need both manage_pages and publish_pages permissions to be able to publish as a Page. The publish_actions permission is required to publish as an individual.

See Facebook's publishing documentation for more info:

• https://developers.facebook.com/docs/pages/publishing
• https://developers.facebook.com/docs/pages/publishing#personal_post
• https://developers.facebook.com/docs/facebook-login/permissions#reference-publish_pages

Examples

iex> # publish a message
iex> Facebook.publish(:feed, "<Feed Id>", [message: "<Message Body"], "<Access Token>")
{:ok, %{"id" => "{page_id}_{post_id}"}}

iex> # publish a link and message
iex> Facebook.publish(:feed, "<Feed Id>", [message: "<Message Body", link: "www.example.com"], "<Access Token>")
{:ok, %{"id" => "{page_id}_{post_id}"}}

iex> # create a Facebook Campaign
iex> Facebook.publish(:campaigns, "act_1234546", [objective: "LINK_CLICKS", name: "a campaign"], "<Access Token>")
{:ok, %{"id" => "{campaign_id}"}}

Publish media to a feed. Author (user or page) is determined from the supplied token.

The page_id/0 is the id for the user or page feed to publish to. Same :feed publishing permissions apply.

Example

iex> Facebook.publish(:photo, "<Feed Id>", "<Image Path>", [], "<Access Token>")
{:ok, %{"id" => photo_id, "post_id" => "{page_id}_{post_id}"}

iex> Facebook.publish(:video, "<Feed Id>", "<Video Path>", [], "<Access Token>")
{:ok, %{"id" => video_id}

See: https://developers.facebook.com/docs/pages/publishing#fotos_videos

If you want to use an appsecret proof, pass it into set_app_secret:

Example

iex> Facebook.set_app_secret("app_secret")

See: https://developers.facebook.com/docs/graph-api/securing-requests

Called when an application is started.

This function is called when an application is started using Application.start/2 (and functions on top of that, such as Application.ensure_started/2). This function should start the top-level process of the application (which should be the top supervisor of the application's supervision tree if the application follows the OTP design principles around supervision).

start_type defines how the application is started:

• :normal - used if the startup is a normal startup or if the application is distributed and is started on the current node because of a failover from another node and the application specification key :start_phases is :undefined.
• {:takeover, node} - used if the application is distributed and is started on the current node because of a failover on the node node.
• {:failover, node} - used if the application is distributed and is started on the current node because of a failover on node node, and the application specification key :start_phases is not :undefined.

start_args are the arguments passed to the application in the :mod specification key (e.g., mod: {MyApp, [:my_args]}).

This function should either return {:ok, pid} or {:ok, pid, state} if startup is successful. pid should be the PID of the top supervisor. state can be an arbitrary term, and if omitted will default to []; if the application is later stopped, state is passed to the stop/1 callback (see the documentation for the c:stop/1 callback for more information).

use Application provides no default implementation for the start/2 callback.

Callback implementation for Application.start/2.

Get all test users for an app.

The access token in this case needs to be an app access token. See:

• https://developers.facebook.com/docs/facebook-login/access-tokens#apptokens
• https://developers.facebook.com/docs/graph-api/reference/v2.8/app/accounts/test-users

Examples

iex> Facebook.test_users("appId", "appId|appSecret")
{:ok, %{"data" => [
  %{
    "access_token" => "ACCESS_TOKEN",
    "id" => "USER_ID",
    "login_url" => "https://developers.facebook.com/checkpoint/test-user-login/USER_ID/"
  }
]}