Saltar al contenido principal

Introducción al endpoint de consulta de cuentas silenciadas

Esta guía de inicio rápido le ayudará a realizar su primera solicitud al endpoint de consulta de cuentas silenciadas con Postman. Visite nuestro repositorio de GitHub X API v2 sample code si desea ver código de ejemplo en distintos lenguajes.
Requisitos previosPara completar esta guía, necesitará un conjunto de keys and tokens para autenticar su solicitud. Puede generar estas keys and tokens siguiendo estos pasos:

Pasos para crear una solicitud de consulta de silenciamientos

Paso uno: Comienza con una herramienta o biblioteca

Hay varias herramientas, ejemplos de código y bibliotecas que puedes usar para hacer una solicitud a este endpoint, pero aquí usaremos Postman para simplificar el proceso. Para cargar en tu entorno la colección de Postman de X API v2, haz clic en el siguiente botón: Una vez que tengas cargada la colección de X API v2 en Postman, navega a la carpeta “Mutes” y selecciona “Mutes lookup”.  

Paso dos: Autentica tu solicitud

Para realizar correctamente una solicitud a la X API, debes verificar que cuentas con permiso. Para hacerlo con este endpoint, debes autenticar tu solicitud usando OAuth 1.0a User Context o OAuth 2.0 Authorization Code with PKCE. En este ejemplo, usaremos OAuth 1.0a User Context. Debes agregar tus claves y tokens —específicamente tu API Key, API Secret Key, OAuth 1.0a user Access Token y OAuth 1.0a user Access Token Secret— en Postman. Puedes hacerlo seleccionando el entorno llamado “X API v2” en la esquina superior derecha de Postman y agregando tus claves y tokens en los campos “initial value” y “current value” (haciendo clic en el icono de ojo junto al menú desplegable de entornos). Estas variables se incorporarán automáticamente en la pestaña de autorización de la solicitud si lo has configurado correctamente.  

Paso tres: Especificar un usuario

Con este endpoint, debes especificar tu id de usuario o el id de un usuario autenticado para ver a quién has silenciado tú o el usuario autenticado. En Postman, ve a la pestaña “Params” e introduce el id del usuario autenticado en la columna “Value” del parámetro id bajo “Path Variables” (al final de la sección), asegurándote de no incluir espacios antes o después del id. Sobre la sección “Path Variables”, verás que hay “Query Params” opcionales para agregar. Para este ejemplo, marcaremos la variable max_results y añadiremos un valor de 5.
KeyValueParameter Type
id(tu id de usuario)Path
max_results5Query

Paso cuatro: Identificar y especificar qué fields desea obtener

Si hace clic en el botón “Send” después del paso tres, recibirá en su respuesta los fields predeterminados del user object: id, name y username. Si desea recibir fields adicionales más allá de id, name y username, deberá especificarlos en su solicitud con los parámetros fields y/o expansions. Para este ejercicio, solicitaremos tres conjuntos adicionales de fields de distintos objetos:
  1. El field adicional user.created_at en los objetos de usuario principales.
  2. Los fields predeterminados del objeto de Posts fijados asociados para los usuarios devueltos: id y text.
  3. El field adicional tweet.created_at en los objetos de Post asociados.
En Postman, vaya a la pestaña “Params” y agregue el siguiente par key:value a la tabla “Query Params”:
KeyValueReturned fields
user.fieldscreated_atuser.created_at
expansionspinned_tweet_idtweet.id, tweet.text
tweet.fieldscreated_atincludes.tweets.created_at
Ahora debería ver una URL similar con su propio user id en lugar de la URL de id de ejemplo junto al botón “Send”: https://api.x.com/2/users/1324848235714736129/muting?user.fields=created_at&expansions=pinned_tweet_id&tweet.fields=created_at&max_results=5

Paso cinco: realiza tu solicitud y revisa la respuesta

Una vez que tengas todo configurado, haz clic en el botón “Send” y recibirás una respuesta similar al siguiente ejemplo:
{
  "data": [
    {
      "username": "TwitterDev",
      "created_at": "2013-12-14T04:35:55.000Z",
      "id": "2244994945",
      "name": "Twitter Dev",
      "pinned_tweet_id": "1430984356139470849"
    }
  ],
  "includes": {
    "tweets": [
      {
        "created_at": "2021-08-26T20:03:51.000Z",
        "id": "1430984356139470849",
        "text": "Help us build a better Twitter Developer Platform!\n \nTake the annual developer survey >>> https://t.co/9yTbEKlJHH https://t.co/fYIwKPzqua"
      }
    ]
  },
  "meta": {
    "result_count": 1
  }
}

Paso seis: pagina tus resultados

Es posible que notes que hay un objeto meta al final de la respuesta. Si recibiste un next_token, esto indica que hay otra página de resultados que se puede recuperar. Para obtener la página siguiente, toma el valor del campo next_token y añádelo a la solicitud como valor de un parámetro de consulta adicional llamado pagination_token.  
ClaveValor
pagination_token1710819323648428707
Si envías la solicitud tras añadir este parámetro adicional, los cinco resultados siguientes se entregarán en la carga útil posterior, ya que especificamos max_results en 5 en el paso tres. Puedes seguir repitiendo este proceso hasta que se hayan devuelto todos los resultados, pero también puedes usar el parámetro max_results para solicitar hasta 1000 usuarios por solicitud, de modo que no tengas que paginar los resultados con tanta frecuencia.