Google is committed to advancing racial equity for Black communities. See how.
इस पेज का अनुवाद Cloud Translation API से किया गया है.
Switch to English

ऐप सर्वर भेजें अनुरोध भेजें

फायरबेस व्यवस्थापक एसडीके या एफसीएम ऐप सर्वर प्रोटोकॉल का उपयोग करके, आप संदेश अनुरोधों का निर्माण कर सकते हैं और उन्हें इस प्रकार के लक्ष्यों को भेज सकते हैं:

  • विषय का नाम
  • स्थिति
  • डिवाइस पंजीकरण टोकन
  • डिवाइस समूह का नाम (केवल Node.js के लिए विरासत प्रोटोकॉल और फायरबेस व्यवस्थापक एसडीके)

आप पूर्वनिर्धारित क्षेत्रों से बने अधिसूचना पेलोड, अपने स्वयं के उपयोगकर्ता-परिभाषित क्षेत्रों के डेटा पेलोड या दोनों प्रकार के पेलोड वाले संदेश के साथ संदेश भेज सकते हैं। अधिक जानकारी के लिए संदेश प्रकार देखें।

इस पृष्ठ के उदाहरण दिखाते हैं कि फायरबेस व्यवस्थापक एसडीके (जिसमें नोड , जावा , पायथन , सी # , और गो के लिए समर्थन है ) और v1 HTTP प्रोटोकॉल का उपयोग करके अधिसूचना संदेश कैसे भेजें। विरासत HTTP और XMPP प्रोटोकॉल के माध्यम से संदेश भेजने के लिए मार्गदर्शन भी है

विशिष्ट उपकरणों को संदेश भेजें

किसी एकल, विशिष्ट डिवाइस पर भेजने के लिए, डिवाइस के पंजीकरण टोकन को दिखाए अनुसार पास करें। पंजीकरण टोकन के बारे में अधिक जानने के लिए अपने प्लेटफ़ॉर्म के लिए क्लाइंट सेटअप जानकारी देखें।

Node.js

 // This registration token comes from the client FCM SDKs.
var registrationToken = 'YOUR_REGISTRATION_TOKEN';

var message = {
  data: {
    score: '850',
    time: '2:45'
  },
  token: registrationToken
};

// Send a message to the device corresponding to the provided
// registration token.
admin.messaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });
 

जावा

 // This registration token comes from the client FCM SDKs.
String registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
Message message = Message.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .setToken(registrationToken)
    .build();

// Send a message to the device corresponding to the provided
// registration token.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response); 

अजगर

 # This registration token comes from the client FCM SDKs.
registration_token = 'YOUR_REGISTRATION_TOKEN'

# See documentation on defining a message payload.
message = messaging.Message(
    data={
        'score': '850',
        'time': '2:45',
    },
    token=registration_token,
)

# Send a message to the device corresponding to the provided
# registration token.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response) 

जाओ

 // Obtain a messaging.Client from the App.
ctx := context.Background()
client, err := app.Messaging(ctx)
if err != nil {
	log.Fatalf("error getting Messaging client: %v\n", err)
}

// This registration token comes from the client FCM SDKs.
registrationToken := "YOUR_REGISTRATION_TOKEN"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Token: registrationToken,
}

// Send a message to the device corresponding to the provided
// registration token.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response) 

सी#

 // This registration token comes from the client FCM SDKs.
var registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
var message = new Message()
{
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
    Token = registrationToken,
};

// Send a message to the device corresponding to the provided
// registration token.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
 

आराम

 POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
   "message":{
      "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
      "notification":{
        "body":"This is an FCM notification message!",
        "title":"FCM Message"
      }
   }
}
 

CURL कमांड:

 curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message":{
   "notification":{
     "title":"FCM Message",
     "body":"This is an FCM Message"
   },
   "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send
 

सफलता पर, प्रत्येक भेजने का तरीका एक संदेश आईडी देता है। Firebase Admin SDK प्रारूप projects/{project_id}/messages/{message_id} में ID स्ट्रिंग लौटाता है। HTTP प्रोटोकॉल प्रतिक्रिया एक JSON कुंजी है:

     {
      "name":"projects/myproject-b5ae1/messages/0:1500415314455276%31bd1c9631bd1c96"
    }
 

कई उपकरणों के लिए संदेश भेजें

REST API और व्यवस्थापन FCM API आपको संदेश को डिवाइस पंजीकरण टोकन की सूची में मल्टीकास्ट करने की अनुमति देते हैं। आप प्रति आह्वान पर 100 डिवाइस पंजीकरण टोकन (जावा और Node.js के लिए 500) तक निर्दिष्ट कर सकते हैं।

Node.js

 // Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
}

admin.messaging().sendMulticast(message)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');
 

जावा

 // Create a list containing up to 100 registration tokens.
// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully"); 

अजगर

 # Create a list containing up to 500 registration tokens.
# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count)) 

जाओ

 // Create a list containing up to 100 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount) 

सी#

 // Create a list containing up to 100 registration tokens.
// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendMulticastAsync(message);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully"); 

आराम

एक HTTP बैच अनुरोध का निर्माण करें:

 --subrequest_boundary
Content-Type: application/http
Content-Transfer-Encoding: binary
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

POST /v1/projects/myproject-b5ae1/messages:send
Content-Type: application/json
accept: application/json

{
  "message":{
     "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
     "notification":{
       "title":"FCM Message",
       "body":"This is an FCM notification message!"
     }
  }
}

...

--subrequest_boundary
Content-Type: application/http
Content-Transfer-Encoding: binary
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

POST /v1/projects/myproject-b5ae1/messages:send
Content-Type: application/json
accept: application/json

{
  "message":{
     "token":"cR1rjyj4_Kc:APA91bGusqbypSuMdsh7jSNrW4nzsM...",
     "notification":{
       "title":"FCM Message",
       "body":"This is an FCM notification message!"
     }
  }
}
--subrequest_boundary--
 

फ़ाइल में अनुरोध सहेजें (इस उदाहरण में बैच_request.txt)। फिर CURL कमांड का उपयोग करें:

 curl --data-binary @batch_request.txt -H 'Content-Type: multipart/mixed; boundary="subrequest_boundary"' https://fcm.googleapis.com/batch
 

sendAll() व्यवस्थापक एसडीके के लिए, यह ऑपरेशन हुड के तहत sendAll() एपीआई का उपयोग करता है, जैसा कि उदाहरणों में दिखाया गया है। रिटर्न वैल्यू एक BatchResponse जिसकी प्रतिक्रिया सूची इनपुट टोकन के क्रम से मेल खाती है। यह तब उपयोगी होता है जब आप जांचना चाहते हैं कि त्रुटियों के कारण कौन से टोकन थे।

Node.js

 // These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
}

admin.messaging().sendMulticast(message)
  .then((response) => {
    if (response.failureCount > 0) {
      const failedTokens = [];
      response.responses.forEach((resp, idx) => {
        if (!resp.success) {
          failedTokens.push(registrationTokens[idx]);
        }
      });
      console.log('List of tokens that caused failures: ' + failedTokens);
    }
  });
 

जावा

 // These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
if (response.getFailureCount() > 0) {
  List<SendResponse> responses = response.getResponses();
  List<String> failedTokens = new ArrayList<>();
  for (int i = 0; i < responses.size(); i++) {
    if (!responses.get(i).isSuccessful()) {
      // The order of responses corresponds to the order of the registration tokens.
      failedTokens.add(registrationTokens.get(i));
    }
  }

  System.out.println("List of tokens that caused failures: " + failedTokens);
} 

अजगर

 # These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
if response.failure_count > 0:
    responses = response.responses
    failed_tokens = []
    for idx, resp in enumerate(responses):
        if not resp.success:
            # The order of responses corresponds to the order of the registration tokens.
            failed_tokens.append(registration_tokens[idx])
    print('List of tokens that caused failures: {0}'.format(failed_tokens)) 

जाओ

 // Create a list containing up to 100 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

if br.FailureCount > 0 {
	var failedTokens []string
	for idx, resp := range br.Responses {
		if !resp.Success {
			// The order of responses corresponds to the order of the registration tokens.
			failedTokens = append(failedTokens, registrationTokens[idx])
		}
	}

	fmt.Printf("List of tokens that caused failures: %v\n", failedTokens)
} 

सी#

 // These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendMulticastAsync(message);
if (response.FailureCount > 0)
{
    var failedTokens = new List<string>();
    for (var i = 0; i < response.Responses.Count; i++)
    {
        if (!response.Responses[i].IsSuccess)
        {
            // The order of responses corresponds to the order of the registration tokens.
            failedTokens.Add(registrationTokens[i]);
        }
    }

    Console.WriteLine($"List of tokens that caused failures: {failedTokens}");
}
 

आराम

प्रत्येक उप-भेजें प्रतिसाद भेजता है। प्रतिक्रियाएं --batch_ शुरू होने वाली प्रतिक्रिया सीमा स्ट्रिंग द्वारा अलग हो जाती हैं।

 --batch_nDhMX4IzFTDLsCJ3kHH7v_44ua-aJT6q
Content-Type: application/http
Content-ID: response-

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Vary: Origin
Vary: X-Origin
Vary: Referer

{
  "name": "projects/35006771263/messages/0:1570471792141125%43c11b7043c11b70"
}

...

--batch_nDhMX4IzFTDLsCJ3kHH7v_44ua-aJT6q
Content-Type: application/http
Content-ID: response-

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Vary: Origin
Vary: X-Origin
Vary: Referer

{
  "name": "projects/35006771263/messages/0:1570471792141696%43c11b7043c11b70"
}

--batch_nDhMX4IzFTDLsCJ3kHH7v_44ua-aJT6q--
 

विषयों को संदेश भेजें

आपके द्वारा कोई विषय बनाए जाने के बाद, क्लाइंट साइड पर या सर्वर API के माध्यम से विषय पर क्लाइंट ऐप इंस्टेंस की सदस्यता लेकर या तो आप विषय पर संदेश भेज सकते हैं। यदि यह आपकी पहली बार इमारत है, तो FCM के लिए अनुरोध भेजें, महत्वपूर्ण पृष्ठभूमि और सेटअप जानकारी के लिए अपने सर्वर वातावरण और FCM के लिए मार्गदर्शिका देखें।

बैकएंड पर अपने तर्क भेजने में, वांछित विषय का नाम दिखाए अनुसार निर्दिष्ट करें:

Node.js

 // The topic name can be optionally prefixed with "/topics/".
var topic = 'highScores';

var message = {
  data: {
    score: '850',
    time: '2:45'
  },
  topic: topic
};

// Send a message to devices subscribed to the provided topic.
admin.messaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });
 

जावा

 // The topic name can be optionally prefixed with "/topics/".
String topic = "highScores";

// See documentation on defining a message payload.
Message message = Message.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .setTopic(topic)
    .build();

// Send a message to the devices subscribed to the provided topic.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response); 

अजगर

 # The topic name can be optionally prefixed with "/topics/".
topic = 'highScores'

# See documentation on defining a message payload.
message = messaging.Message(
    data={
        'score': '850',
        'time': '2:45',
    },
    topic=topic,
)

# Send a message to the devices subscribed to the provided topic.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response) 

जाओ

 // The topic name can be optionally prefixed with "/topics/".
topic := "highScores"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Topic: topic,
}

// Send a message to the devices subscribed to the provided topic.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response) 

सी#

 // The topic name can be optionally prefixed with "/topics/".
var topic = "highScores";

// See documentation on defining a message payload.
var message = new Message()
{
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
    Topic = topic,
};

// Send a message to the devices subscribed to the provided topic.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
 

आराम

 POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
    "topic" : "foo-bar",
    "notification" : {
      "body" : "This is a Firebase Cloud Messaging Topic Message!",
      "title" : "FCM Message"
      }
   }
}
 

CURL कमांड:

 curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
  "message": {
    "topic" : "foo-bar",
    "notification": {
      "body": "This is a Firebase Cloud Messaging Topic Message!",
      "title": "FCM Message"
    }
  }
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
 

विषयों के संयोजन के लिए एक संदेश भेजने के लिए, एक शर्त निर्दिष्ट करें, जो एक बूलियन अभिव्यक्ति है जो लक्ष्य विषयों को निर्दिष्ट करती है। उदाहरण के लिए, निम्न स्थिति TopicA और TopicB या TopicC सदस्यता वाले उपकरणों को संदेश TopicC :

 "'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"
 

एफसीएम पहले कोष्ठकों में किसी भी स्थिति का मूल्यांकन करता है, और फिर बाएं से दाएं की अभिव्यक्ति का मूल्यांकन करता है। उपरोक्त अभिव्यक्ति में, किसी भी एक विषय के लिए सदस्यता लिया गया उपयोगकर्ता संदेश प्राप्त नहीं करता है। इसी तरह, TopicA सदस्यता नहीं लेने वाले उपयोगकर्ता को संदेश प्राप्त नहीं होता है। ये संयोजन इसे प्राप्त करते हैं:

  • TopicA और TopicB
  • TopicA और TopicC

आप अपनी सशर्त अभिव्यक्ति में अधिकतम पांच विषय शामिल कर सकते हैं।

एक शर्त भेजने के लिए:

Node.js

 // Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
var condition = "'stock-GOOG' in topics || 'industry-tech' in topics";

// See documentation on defining a message payload.
var message = {
  notification: {
    title: '$GOOG up 1.43% on the day',
    body: '$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  condition: condition
};

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
admin.messaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });
 

जावा

 // Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
String condition = "'stock-GOOG' in topics || 'industry-tech' in topics";

// See documentation on defining a message payload.
Message message = Message.builder()
    .setNotification(new Notification(
        "$GOOG up 1.43% on the day",
        "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day."))
    .setCondition(condition)
    .build();

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response); 

अजगर

 # Define a condition which will send to devices which are subscribed
# to either the Google stock or the tech industry topics.
condition = "'stock-GOOG' in topics || 'industry-tech' in topics"

# See documentation on defining a message payload.
message = messaging.Message(
    notification=messaging.Notification(
        title='$GOOG up 1.43% on the day',
        body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
    ),
    condition=condition,
)

# Send a message to devices subscribed to the combination of topics
# specified by the provided condition.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response) 

जाओ

 // Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
condition := "'stock-GOOG' in topics || 'industry-tech' in topics"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Condition: condition,
}

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response) 

सी#

 // Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
var condition = "'stock-GOOG' in topics || 'industry-tech' in topics";

// See documentation on defining a message payload.
var message = new Message()
{
    Notification = new Notification()
    {
        Title = "$GOOG up 1.43% on the day",
        Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
    },
    Condition = condition,
};

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
 

आराम

 POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
   "message":{
    "condition": "'dogs' in topics || 'cats' in topics",
    "notification" : {
      "body" : "This is a Firebase Cloud Messaging Topic Message!",
      "title" : "FCM Message",
    }
  }
}
 

CURL कमांड:

 curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
  "notification": {
    "title": "FCM Message",
    "body": "This is a Firebase Cloud Messaging Topic Message!",
  },
  "condition": "'dogs' in topics || 'cats' in topics"
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
 

संदेशों का एक बैच भेजें

REST API और एडमिन SDK बैचों में संदेश भेजने का समर्थन करते हैं। आप प्रत्येक संदेश में अलग-अलग HTTP अनुरोध भेजने पर महत्वपूर्ण प्रदर्शन सुधार के साथ, 500 संदेशों को एक बैच में समूह बना सकते हैं और उन सभी को एक एपीआई कॉल में भेज सकते हैं।

इस सुविधा का उपयोग संदेशों के एक स्वनिर्धारित सेट को बनाने और विभिन्न प्राप्तकर्ताओं को भेजने के लिए किया जा सकता है, जिसमें विषय या विशिष्ट उपकरण पंजीकरण टोकन शामिल हैं। इस सुविधा का उपयोग तब करें, उदाहरण के लिए, आपको संदेश बॉडी में अलग-अलग विवरणों के साथ अलग-अलग दर्शकों को संदेश भेजने की आवश्यकता है।

Node.js

 // Create a list containing up to 500 messages.
const messages = [];
messages.push({
  notification: {title: 'Price drop', body: '5% off all electronics'},
  token: registrationToken,
});
messages.push({
  notification: {title: 'Price drop', body: '2% off all books'},
  topic: 'readers-club',
});

admin.messaging().sendAll(messages)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');
  });
 

जावा

 // Create a list containing up to 500 messages.
List<Message> messages = Arrays.asList(
    Message.builder()
        .setNotification(new Notification("Price drop", "5% off all electronics"))
        .setToken(registrationToken)
        .build(),
    // ...
    Message.builder()
        .setNotification(new Notification("Price drop", "2% off all books"))
        .setTopic("readers-club")
        .build()
);

BatchResponse response = FirebaseMessaging.getInstance().sendAll(messages);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully"); 

अजगर

 # Create a list containing up to 500 messages.
messages = [
    messaging.Message(
        notification=messaging.Notification('Price drop', '5% off all electronics'),
        token=registration_token,
    ),
    # ...
    messaging.Message(
        notification=messaging.Notification('Price drop', '2% off all books'),
        topic='readers-club',
    ),
]

response = messaging.send_all(messages)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count)) 

जाओ

 // Create a list containing up to 100 messages.
messages := []*messaging.Message{
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "5% off all electronics",
		},
		Token: registrationToken,
	},
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "2% off all books",
		},
		Topic: "readers-club",
	},
}

br, err := client.SendAll(context.Background(), messages)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount) 

सी#

 // Create a list containing up to 100 messages.
var messages = new List<Message>()
{
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "5% off all electronics",
        },
        Token = registrationToken,
    },
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "2% off all books",
        },
        Topic = "readers-club",
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendAllAsync(messages);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully"); 

आराम

उप अनुरोधों की सूची को जोड़कर एक HTTP बैच अनुरोध का निर्माण करें:

 --subrequest_boundary
Content-Type: application/http
Content-Transfer-Encoding: binary
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

POST /v1/projects/myproject-b5ae1/messages:send
Content-Type: application/json
accept: application/json

{
  "message":{
     "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
     "notification":{
       "title":"FCM Message",
       "body":"This is an FCM notification message to device 0!"
     }
  }
}

--subrequest_boundary
Content-Type: application/http
Content-Transfer-Encoding: binary
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

POST /v1/projects/myproject-b5ae1/messages:send
Content-Type: application/json
accept: application/json

{
  "message":{
     "topic":"readers-club",
     "notification":{
       "title":"Price drop",
       "body":"2% off all books"
     }
  }
}

...

--subrequest_boundary
Content-Type: application/http
Content-Transfer-Encoding: binary
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

POST /v1/projects/myproject-b5ae1/messages:send
Content-Type: application/json
accept: application/json

{
  "message":{
     "token":"cR1rjyj4_Kc:APA91bGusqbypSuMdsh7jSNrW4nzsM...",
     "notification":{
       "title":"FCM Message",
       "body":"This is an FCM notification message to device N!"
     }
  }
}
--subrequest_boundary--
 

आप BatchResponse को BatchResponse कितने संदेश दिए गए थे, यह जाँचने के लिए आप लौटे BatchResponse को क्वेरी कर सकते हैं। यह उन प्रतिक्रियाओं की एक सूची भी उजागर करता है जिनका उपयोग व्यक्तिगत संदेशों की स्थिति की जांच के लिए किया जा सकता है। प्रतिक्रियाओं का क्रम इनपुट सूची में संदेशों के क्रम से मेल खाता है।

सीधे बूट-सक्षम संदेश भेजें (केवल Android)

आप HTTP बूट या विरासत HTTP APIs का उपयोग करके सीधे बूट मोड में उपकरणों को संदेश भेज सकते हैं। डायरेक्ट बूट मोड में डिवाइस भेजने से पहले, सुनिश्चित करें कि आपने क्लाइंट डिवाइस को डायरेक्ट बूट मोड में FCM संदेश प्राप्त करने में सक्षम करने के लिए कदम पूरा कर लिया है

FCM v1 HTTP API का उपयोग करके भेजें

संदेश अनुरोध में कुंजी "direct_book_ok" : true शामिल होना चाहिए "direct_book_ok" : true अनुरोध निकाय के AndroidConfig विकल्पों में "direct_book_ok" : true । उदाहरण के लिए:

 https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
  "Message":{
    "token" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
    "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "android": {
      "direct_boot_ok": true,
    },
}
 

FCM विरासत HTTP API का उपयोग करके भेजें

संदेश अनुरोध में कुंजी "direct_book_ok" : true शामिल होना चाहिए "direct_book_ok" : true अनुरोध निकाय के शीर्ष स्तर पर "direct_book_ok" : true । उदाहरण के लिए:

 https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{ "data": {
    "score": "5x1",
    "time": "15:10"
  },
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  "direct_book_ok" : true
}
 

अनुरोध निकाय में इस कुंजी के साथ भेजे गए संदेश वर्तमान में सीधे बूट मोड में उपकरणों पर ऐप द्वारा नियंत्रित किए जा सकते हैं (और यह भी कि उस मोड में नहीं है)।

प्लेटफ़ॉर्म पर संदेशों को कस्टमाइज़ करें

Firebase व्यवस्थापक SDK और FCM v1 HTTP प्रोटोकॉल दोनों आपके संदेश अनुरोधों को message ऑब्जेक्ट में उपलब्ध सभी फ़ील्ड सेट करने की अनुमति देते हैं। यह भी शामिल है:

  • संदेश प्राप्त करने वाले सभी ऐप इंस्टेंस द्वारा व्याख्या किए जाने वाले फ़ील्ड का एक सामान्य सेट।
  • प्लेटफ़ॉर्म-विशिष्ट सेट जैसे कि AndroidConfig और WebpushConfig , की व्याख्या केवल निर्दिष्ट प्लेटफ़ॉर्म पर चलने वाले ऐप इंस्टेंस द्वारा की जाती है।

प्लेटफ़ॉर्म-विशिष्ट ब्लॉक आपको विभिन्न प्लेटफ़ॉर्म के लिए संदेशों को अनुकूलित करने के लिए लचीलापन देते हैं ताकि यह सुनिश्चित हो सके कि वे प्राप्त होने पर सही तरीके से नियंत्रित किए जाते हैं। FCM बैकएंड सभी निर्दिष्ट मापदंडों को ध्यान में रखेगा और प्रत्येक प्लेटफ़ॉर्म के लिए संदेश को अनुकूलित करेगा।

आम खेतों का उपयोग कब करें

जब आप सामान्य फ़ील्ड का उपयोग करें:

  • सभी प्लेटफार्मों पर ऐप इंस्टेंस को लक्षित करना - आईओएस, एंड्रॉइड और वेब
  • विषयों को संदेश भेजना

प्लेटफ़ॉर्म की परवाह किए बिना सभी एप्लिकेशन इंस्टेंस, निम्नलिखित सामान्य क्षेत्रों की व्याख्या कर सकते हैं:

प्लेटफ़ॉर्म-विशिष्ट फ़ील्ड का उपयोग कब करें

जब आप चाहते हैं तो प्लेटफ़ॉर्म-विशिष्ट फ़ील्ड का उपयोग करें:

  • केवल विशेष प्लेटफ़ॉर्म पर फ़ील्ड भेजें
  • आम क्षेत्रों के अलावा प्लेटफ़ॉर्म-विशिष्ट फ़ील्ड भेजें

जब भी आप केवल विशेष प्लेटफ़ॉर्म पर मान भेजना चाहते हैं, तो सामान्य फ़ील्ड का उपयोग करें; प्लेटफ़ॉर्म-विशिष्ट फ़ील्ड का उपयोग करें। उदाहरण के लिए, केवल iOS और वेब पर सूचना भेजने के लिए, लेकिन Android के लिए नहीं, आपको दो अलग-अलग सेट फ़ील्ड का उपयोग करना होगा, एक iOS के लिए और दूसरा वेब के लिए।

जब आप विशिष्ट वितरण विकल्पों के साथ संदेश भेज रहे हैं, तो उन्हें सेट करने के लिए प्लेटफ़ॉर्म-विशिष्ट फ़ील्ड का उपयोग करें। आप चाहें तो प्रति प्लेटफ़ॉर्म पर अलग-अलग मान निर्दिष्ट कर सकते हैं। हालाँकि, जब आप प्लेटफ़ॉर्म पर समान मूल्य को अनिवार्य रूप से सेट करना चाहते हैं, तब भी आपको प्लेटफ़ॉर्म-विशिष्ट फ़ील्ड का उपयोग करना चाहिए। ऐसा इसलिए है क्योंकि प्रत्येक प्लेटफ़ॉर्म मूल्य को थोड़ा अलग तरीके से व्याख्या कर सकता है- उदाहरण के लिए, समय-समय पर एंड्रॉइड पर सेकंड में समाप्ति समय के रूप में एंड्रॉइड पर सेट किया जाता है, जबकि आईओएस पर यह समाप्ति तिथि के रूप में सेट किया जाता है।

उदाहरण: प्लेटफ़ॉर्म-विशिष्ट वितरण विकल्पों के साथ अधिसूचना संदेश

निम्नलिखित भेजें अनुरोध सभी प्लेटफार्मों पर एक सामान्य अधिसूचना शीर्षक और सामग्री भेजता है, लेकिन यह कुछ प्लेटफ़ॉर्म-विशिष्ट ओवरराइड भी भेजता है। विशेष रूप से, अनुरोध:

  • एंड्रॉइड के लिए लंबे समय से लाइव सेट करता है, साथ ही एंड्रॉइड डिवाइस पर प्रदर्शित करने के लिए एक विशेष आइकन और रंग के साथ।
  • IOS उपकरणों के वितरण के लिए APNs पेलोड में iOS-केवल badge फ़ील्ड सेट करता है।

Node.js

 var message = {
  notification: {
    title: '$GOOG up 1.43% on the day',
    body: '$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
  },
  android: {
    ttl: 3600 * 1000,
    notification: {
      icon: 'stock_ticker_update',
      color: '#f45342',
    },
  },
  apns: {
    payload: {
      aps: {
        badge: 42,
      },
    },
  },
  topic: 'industry-tech'
};
 

जावा

 Message message = Message.builder()
    .setNotification(new Notification(
        "$GOOG up 1.43% on the day",
        "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day."))
    .setAndroidConfig(AndroidConfig.builder()
        .setTtl(3600 * 1000)
        .setNotification(AndroidNotification.builder()
            .setIcon("stock_ticker_update")
            .setColor("#f45342")
            .build())
        .build())
    .setApnsConfig(ApnsConfig.builder()
        .setAps(Aps.builder()
            .setBadge(42)
            .build())
        .build())
    .setTopic("industry-tech")
    .build(); 

अजगर

 message = messaging.Message(
    notification=messaging.Notification(
        title='$GOOG up 1.43% on the day',
        body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
    ),
    android=messaging.AndroidConfig(
        ttl=datetime.timedelta(seconds=3600),
        priority='normal',
        notification=messaging.AndroidNotification(
            icon='stock_ticker_update',
            color='#f45342'
        ),
    ),
    apns=messaging.APNSConfig(
        payload=messaging.APNSPayload(
            aps=messaging.Aps(badge=42),
        ),
    ),
    topic='industry-tech',
) 

जाओ

 oneHour := time.Duration(1) * time.Hour
badge := 42
message := &messaging.Message{
	Notification: &messaging.Notification{
		Title: "$GOOG up 1.43% on the day",
		Body:  "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
	},
	Android: &messaging.AndroidConfig{
		TTL: &oneHour,
		Notification: &messaging.AndroidNotification{
			Icon:  "stock_ticker_update",
			Color: "#f45342",
		},
	},
	APNS: &messaging.APNSConfig{
		Payload: &messaging.APNSPayload{
			Aps: &messaging.Aps{
				Badge: &badge,
			},
		},
	},
	Topic: "industry-tech",
} 

सी#

 var message = new Message
{
    Notification = new Notification()
    {
        Title = "$GOOG up 1.43% on the day",
        Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
    },
    Android = new AndroidConfig()
    {
        TimeToLive = TimeSpan.FromHours(1),
        Notification = new AndroidNotification()
        {
            Icon = "stock_ticker_update",
            Color = "#f45342",
        },
    },
    Apns = new ApnsConfig()
    {
        Aps = new Aps()
        {
            Badge = 42,
        },
    },
    Topic = "industry-tech",
}; 

आराम

 {
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"`$GOOG` up 1.43% on the day",
       "body":"GOOG gained 11.80 points to close at 835.67, up 1.43% on the day."
     },
     "android":{
       "ttl":"3600s",
       "notification":{
         "icon":"stock_ticker_update",
         "color":"#f45342"
       }
     },
     "apns":{
       "payload":{
         "aps":{
           "badge":"42"
         }
       }
     },
     "webpush":{
       "headers":{
         "TTL":"86400"
       }
     }
   }
 }
 

संदेश बॉडी में प्लेटफ़ॉर्म-विशिष्ट ब्लॉकों में उपलब्ध कुंजियों पर पूर्ण विवरण के लिए HTTP v1 संदर्भ दस्तावेज़ देखें।

व्यवस्थापक त्रुटि कोड

निम्न तालिका अनुशंसित रिज़ॉल्यूशन चरणों सहित फायरबेस व्यवस्थापक एफसीएम एपीआई त्रुटि कोड और उनके विवरणों को सूचीबद्ध करती है।

एरर कोड विवरण और संकल्प कदम
messaging/invalid-argument FCM पद्धति में एक अमान्य तर्क प्रदान किया गया था। त्रुटि संदेश में अतिरिक्त जानकारी होनी चाहिए।
messaging/invalid-recipient इच्छित संदेश प्राप्तकर्ता अमान्य है। त्रुटि संदेश में अतिरिक्त जानकारी होनी चाहिए।
messaging/invalid-payload एक अमान्य संदेश पेलोड ऑब्जेक्ट प्रदान किया गया था। त्रुटि संदेश में अतिरिक्त जानकारी होनी चाहिए।
messaging/invalid-data-payload-key डेटा संदेश पेलोड में एक अमान्य कुंजी है। प्रतिबंधित कुंजी के लिए DataMessagePayload लिए संदर्भ प्रलेखन देखें।
messaging/payload-size-limit-exceeded प्रदान किया गया संदेश पेलोड FCM आकार सीमा से अधिक है। अधिकांश संदेशों के लिए सीमा 4096 बाइट्स है। विषयों पर भेजे गए संदेशों के लिए, सीमा 2048 बाइट्स है। कुल पेलोड आकार में चाबियाँ और मूल्य दोनों शामिल हैं।
messaging/invalid-options एक अमान्य संदेश विकल्प ऑब्जेक्ट प्रदान किया गया था। त्रुटि संदेश में अतिरिक्त जानकारी होनी चाहिए।
messaging/invalid-registration-token अमान्य पंजीकरण टोकन प्रदान किया गया। सुनिश्चित करें कि यह एफसीएम के साथ पंजीकरण से प्राप्त क्लाइंट ऐप के पंजीकरण टोकन से मेल खाता है। अतिरिक्त वर्णों को काट-छाँट या जोड़ न दें।
messaging/registration-token-not-registered प्रदान किया गया पंजीकरण टोकन पंजीकृत नहीं है। एक पूर्व वैध पंजीकरण टोकन विभिन्न कारणों से अपंजीकृत हो सकता है, जिसमें शामिल हैं:
  • क्लाइंट ऐप FCM से खुद को अनरजिस्टर्ड करता है।
  • क्लाइंट ऐप स्वचालित रूप से अपंजीकृत था। यह तब हो सकता है यदि उपयोगकर्ता एप्लिकेशन को या iOS पर, यदि APNS प्रतिक्रिया सेवा ने APNS टोकन को अमान्य के रूप में रिपोर्ट किया हो।
  • पंजीकरण टोकन समाप्त हो गया। उदाहरण के लिए, Google पंजीकरण टोकन को ताज़ा करने का निर्णय ले सकता है या iOS उपकरणों के लिए APNS टोकन समाप्त हो सकता है।
  • क्लाइंट ऐप को अपडेट किया गया था, लेकिन संदेश प्राप्त करने के लिए नया संस्करण कॉन्फ़िगर नहीं किया गया है।
इन सभी मामलों के लिए, इस पंजीकरण टोकन को हटा दें और संदेश भेजने के लिए इसका उपयोग करना बंद कर दें।
messaging/invalid-package-name संदेश एक पंजीकरण टोकन को संबोधित किया गया था जिसका पैकेज नाम प्रदान की गई restrictedPackageName विकल्प से मेल नहीं खाता है।
messaging/message-rate-exceeded किसी विशेष लक्ष्य के लिए संदेशों की दर बहुत अधिक है। इस उपकरण या विषय पर भेजे गए संदेशों की संख्या कम करें और इस लक्ष्य को भेजने से तुरंत पीछे न हटें।
messaging/device-message-rate-exceeded किसी विशेष उपकरण पर संदेशों की दर बहुत अधिक है। इस उपकरण को भेजे गए संदेशों की संख्या कम करें और इस उपकरण को भेजने का तुरंत प्रयास न करें।
messaging/topics-message-rate-exceeded किसी विशेष विषय के ग्राहकों को संदेशों की दर बहुत अधिक है। इस विषय के लिए भेजे गए संदेशों की संख्या कम करें, और इस विषय पर भेजने का तुरंत प्रयास न करें।
messaging/too-many-topics एक पंजीकरण टोकन को अधिकतम विषयों की सदस्यता दी गई है और इसे किसी भी अधिक सदस्यता नहीं दी जा सकती है।
messaging/invalid-apns-credentials IOS डिवाइस पर लक्षित संदेश नहीं भेजा जा सकता क्योंकि आवश्यक APNs SSL प्रमाणपत्र अपलोड नहीं किया गया है या समाप्त हो गया है। अपने विकास और उत्पादन प्रमाणपत्रों की वैधता की जाँच करें।
messaging/mismatched-credential इस एसडीके को प्रमाणित करने के लिए इस्तेमाल की गई साख के पास प्रदान किए गए पंजीकरण टोकन के अनुरूप डिवाइस पर संदेश भेजने की अनुमति नहीं है। सुनिश्चित करें कि क्रेडेंशियल और पंजीकरण टोकन दोनों एक ही फायरबेस परियोजना के हैं। फायरबेस व्यवस्थापक एसडीके को प्रमाणित करने के बारे में प्रलेखन के लिए अपने ऐप में फायरबेस जोड़ें देखें।
messaging/authentication-error एसडीके एफसीएम सर्वरों को प्रमाणित नहीं कर सका। सुनिश्चित करें कि आप Firebase Admin SDK को एक क्रेडेंशियल के साथ प्रमाणित करते हैं जिसमें FCM संदेश भेजने की उचित अनुमति है। Firebase व्यवस्थापक SDKs को प्रमाणित करने के बारे में प्रलेखन के लिए अपने ऐप में Firebase जोड़ें देखें।
messaging/server-unavailable FCM सर्वर समय में अनुरोध को संसाधित नहीं कर सका। आपको उसी अनुरोध को पुनः प्राप्त करना चाहिए, लेकिन आपको निम्न करना चाहिए:
  • अगर यह FCM कनेक्शन सर्वर से प्रतिक्रिया में शामिल है तो Retry-After हैडर का सम्मान Retry-After
  • अपने रिट्री तंत्र में घातीय बैक-ऑफ को लागू करें। उदाहरण के लिए, यदि आपने पहले रिट्रीट से पहले एक सेकंड इंतजार किया, तो अगले एक से पहले कम से कम दो सेकंड प्रतीक्षा करें, फिर चार सेकंड, और इसी तरह। यदि आप कई संदेश भेज रहे हैं, तो एक ही समय में सभी संदेशों के लिए एक नया अनुरोध जारी करने से बचने के लिए एक अतिरिक्त यादृच्छिक राशि से प्रत्येक को स्वतंत्र रूप से विलंबित करें।
वे प्रेषक जो समस्याओं को जोखिम में डालते हैं उन्हें ब्लैकलिस्ट किया जाता है।
messaging/internal-error अनुरोध को संसाधित करने के दौरान FCM सर्वर को एक त्रुटि का सामना करना पड़ा। आप ऊपर दिए गए messaging/server-unavailable पंक्ति में सूचीबद्ध आवश्यकताओं के बाद उसी अनुरोध को पुनः प्राप्त कर सकते हैं। यदि त्रुटि बनी रहती है, तो कृपया हमारे बग रिपोर्ट सहायता चैनल को समस्या की सूचना दें।
messaging/unknown-error एक अज्ञात सर्वर त्रुटि दी गई थी। अधिक जानकारी के लिए त्रुटि संदेश में कच्चे सर्वर की प्रतिक्रिया देखें। यदि आपको यह त्रुटि मिलती है, तो कृपया हमारे बग रिपोर्ट समर्थन चैनल को पूर्ण त्रुटि संदेश दें।

विरासत ऐप सर्वर प्रोटोकॉल का उपयोग करके संदेश भेजें

यदि आप विरासत प्रोटोकॉल का उपयोग करना पसंद करते हैं, तो इस खंड में दिखाए गए संदेश अनुरोधों का निर्माण करें। ध्यान रखें कि, यदि आप HTTP के माध्यम से कई प्लेटफार्मों पर भेज रहे हैं, तो v1 प्रोटोकॉल आपके संदेश अनुरोधों को सरल बना सकता है।

विशिष्ट उपकरणों को संदेश भेजें

विशिष्ट उपकरणों को संदेश भेजने के लिए, पंजीकरण के to कुंजी को विशिष्ट ऐप इंस्टेंस के लिए सेट करें। पंजीकरण टोकन के बारे में अधिक जानने के लिए अपने प्लेटफ़ॉर्म के लिए क्लाइंट सेटअप जानकारी देखें।

HTTP पोस्ट अनुरोध

 https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{ "data": {
    "score": "5x1",
    "time": "15:10"
  },
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}

 

HTTP प्रतिक्रिया

{ "multicast_id": 108,
  "success": 1,
  "failure": 0,
  "results": [
    { "message_id": "1:08" }
  ]
}

XMPP संदेश

 <message id="">
  <gcm xmlns="google:mobile:data">
    { "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  }
  </gcm>
</message>
 

XMPP प्रतिक्रिया

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "from":"REGID",
      "message_id":"m-1366082849205"
      "message_type":"ack"
  }
  </gcm>
</message>

XMPP कनेक्शन सर्वर प्रतिक्रियाओं के लिए कुछ अन्य विकल्प प्रदान करता है। सर्वर प्रतिक्रिया प्रारूप देखें।

क्लाइंट ऐप्स को डाउनस्ट्रीम संदेश भेजते समय उपलब्ध संदेश विकल्पों की पूरी सूची के लिए, अपने चुने हुए कनेक्शन सर्वर प्रोटोकॉल, HTTP या एमपीएमपी के लिए संदर्भ जानकारी देखें।

विषयों को संदेश भेजें

फायरबेस क्लाउड मेसेजिंग विषय पर संदेश भेजना किसी व्यक्तिगत डिवाइस या उपयोगकर्ता समूह को संदेश भेजने के समान है। एप्लिकेशन सर्वर मूल्य /topics/yourTopic जैसे कुंजी के साथ सेट करता to । डेवलपर्स किसी भी विषय का नाम चुन सकते हैं जो नियमित अभिव्यक्ति से मेल खाता हो: "/topics/[a-zA-Z0-9-_.~%]+" / "/topics/[a-zA-Z0-9-_.~%]+" . "/topics/[a-zA-Z0-9-_.~%]+"

अनेक विषय के संयोजन के लिए भेजने के लिए, अनुप्रयोग सर्वर सेट करना होगा condition कुंजी (के बजाय to एक बूलियन शर्त यह है कि निर्दिष्ट लक्ष्य विषयों की कुंजी)। उदाहरण के लिए, TopicA और TopicB या TopicC सदस्यता वाले उपकरणों को संदेश भेजने के लिए:

'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)

एफसीएम पहले कोष्ठकों में किसी भी स्थिति का मूल्यांकन करता है, और फिर बाएं से दाएं की अभिव्यक्ति का मूल्यांकन करता है। उपरोक्त अभिव्यक्ति में, किसी भी एक विषय के लिए सदस्यता लिया गया उपयोगकर्ता संदेश प्राप्त नहीं करता है। इसी तरह, TopicA की सदस्यता नहीं लेने वाले उपयोगकर्ता को संदेश प्राप्त नहीं होता है। ये संयोजन इसे प्राप्त करते हैं:

  • TopicA और TopicB
  • TopicA और TopicC

आप अपनी सशर्त अभिव्यक्ति में अधिकतम पाँच विषय शामिल कर सकते हैं, और कोष्ठक समर्थित हैं। समर्थित ऑपरेटर: && , || , ! । के लिए उपयोग पर ध्यान दें ! :

!('TopicA' in topics)

इस अभिव्यक्ति के साथ, किसी भी ऐप इंस्टेंस जो कि टॉपिक को सब्सक्राइब नहीं किए जाते हैं, जिसमें ऐप इंस्टेंस शामिल हैं जो किसी भी विषय पर सब्सक्राइब नहीं किए गए हैं, संदेश प्राप्त करते हैं।

ऐप सर्वर कुंजियों के बारे में अधिक विस्तार के लिए, अपने चुने हुए कनेक्शन सर्वर प्रोटोकॉल, HTTP या XMPP के लिए संदर्भ जानकारी देखें। इस पृष्ठ के उदाहरणों से पता चलता है कि HTTP और XMPP दोनों में विषयों को संदेश कैसे भेजें।

विषय HTTP पोस्ट अनुरोध

किसी एक विषय पर भेजें:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA


"कुत्तों" या "बिल्लियों" को सब्स्क्राइब्ड किए गए उपकरणों को भेजें:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA


विषय HTTP प्रतिक्रिया

//Success example:
{
  "message_id": "1023456"
}

//failure example:
{
  "error": "TopicsMessageRateExceeded"
}

विषय XMPP संदेश

किसी एक विषय पर भेजें:

 <message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

"कुत्तों" या "बिल्लियों" को सब्स्क्राइब्ड किए गए उपकरणों को भेजें:

<message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

विषय XMPP प्रतिक्रिया

//Success example:
{
  "message_id": "1023456"
}

//failure example:
{
  "error": "TopicsMessageRateExceeded"
}

FCM सर्वर द्वारा अनुरोध भेजने वाले विषय पर सफलता या विफलता की प्रतिक्रिया देने से पहले 30 सेकंड तक की देरी की अपेक्षा करें। अनुरोध के अनुसार ऐप सर्वर के टाइमआउट मान को सेट करना सुनिश्चित करें।

संदेश विकल्पों की पूरी सूची के लिए, अपने चुने हुए कनेक्शन सर्वर प्रोटोकॉल, HTTP या XMPP के लिए संदर्भ जानकारी देखें।

उपकरण समूहों को संदेश भेजें

एक उपकरण समूह में संदेश भेजना एक व्यक्तिगत डिवाइस पर संदेश भेजने के समान है। सेट to डिवाइस समूह के लिए अद्वितीय अधिसूचना कुंजी करने के लिए पैरामीटर। पेलोड समर्थन पर विवरण के लिए संदेश प्रकार देखें। इस पृष्ठ के उदाहरण बताते हैं कि HTTP और XMPP प्रोटोकॉल में डिवाइस समूहों को डेटा संदेश कैसे भेजें।

डिवाइस समूह HTTP पोस्ट अनुरोध

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{
  "to": "aUniqueKey",
  "data": {
    "hello": "This is a Firebase Cloud Messaging Device Group Message!",
   }
}

डिवाइस ग्रुप HTTP रिस्पांस

यहां "सफलता" का एक उदाहरण दिया गया है - notification_key में 2 पंजीकरण टोकन हैं, और संदेश सफलतापूर्वक उन दोनों को भेजा गया था:

{
  "success": 2,
  "failure": 0
}

यहां "आंशिक सफलता" का एक उदाहरण है - notification_key में 3 पंजीकरण टोकन हैं जो इसके साथ जुड़े हैं। संदेश केवल पंजीकरण टोकन में से 1 को सफलतापूर्वक भेजा गया था। प्रतिक्रिया संदेश उस पंजीकरण टोकन को सूचीबद्ध करता है जो संदेश प्राप्त करने में विफल रहा:

{
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

जब कोई मैसेज notification_key जुड़े एक या एक से अधिक पंजीकरण टोकन तक पहुंचाने में विफल रहता है, तो ऐप सर्वर को रिट्रीट के बीच बैकऑफ़ के साथ पुन: प्रयास करना चाहिए।

यदि सर्वर एक ऐसे उपकरण समूह को संदेश भेजने का प्रयास करता है जिसमें कोई सदस्य नहीं है, तो प्रतिक्रिया निम्न की तरह दिखती है, जिसमें 0 सफलता और 0 विफलता है:

{
  "success": 0,
  "failure": 0
}

डिवाइस समूह XMPP संदेश

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "to": "aUniqueKey",
      "message_id": "m-1366082849205" ,
      "data": {
          "hello":"This is a Firebase Cloud Messaging Device Group Message!"
      }
  }
  </gcm>
</message>

डिवाइस ग्रुप XMPP रिस्पांस

जब संदेश सफलतापूर्वक समूह में किसी एक डिवाइस पर भेजा जाता है, तो XMPP कनेक्शन सर्वर ACK के साथ प्रतिक्रिया करता है। यदि समूह में सभी डिवाइस पर भेजे गए सभी संदेश विफल हो जाते हैं, तो XMPP कनेक्शन सर्वर एक NACK के साथ प्रतिक्रिया करता है।

यहां "सफलता" का एक उदाहरण दिया गया है - notification_key में 3 पंजीकरण टोकन हैं, और संदेश सफलतापूर्वक उन सभी को भेजा गया था:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success": 3,
  "failure": 0,
  "message_id": "m-1366082849205"
}

यहां "आंशिक सफलता" का एक उदाहरण है - notification_key में 3 पंजीकरण टोकन हैं जो इसके साथ जुड़े हैं। संदेश केवल पंजीकरण टोकन में से 1 को सफलतापूर्वक भेजा गया था। प्रतिक्रिया संदेश उस पंजीकरण टोकन को सूचीबद्ध करता है जो संदेश प्राप्त करने में विफल रहा:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

जब FCM कनेक्शन सर्वर समूह में सभी उपकरणों को देने में विफल रहता है। ऐप सर्वर को एक नीक प्रतिक्रिया मिलेगी।

संदेश विकल्पों की पूरी सूची के लिए, अपने चुने हुए कनेक्शन सर्वर प्रोटोकॉल, HTTP या XMPP के लिए संदर्भ जानकारी देखें।

Firebase व्यवस्थापक SDK विरासत भेजने के तरीके

Firebase Admin Node.js SDK विरासत FCM सर्वर API के आधार पर (FCM) संदेश भेजने के तरीकों का समर्थन करता है । ये विधियाँ प्रेषक send() विधि की तुलना में विभिन्न तर्कों को स्वीकार करती हैं। आपको जब भी संभव हो, तो send() पद्धति का उपयोग करें और व्यक्तिगत उपकरणों या उपकरण समूहों को संदेश भेजते समय केवल इस पृष्ठ में वर्णित विधियों का उपयोग करें।

व्यक्तिगत उपकरणों को भेजें

आप उस डिवाइस पर एक संदेश भेजने के लिए sendToDevice() विधि के लिए एक पंजीकरण टोकन पास कर सकते हैं:

Node.js

 // This registration token comes from the client FCM SDKs.
var registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
var payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device corresponding to the provided
// registration token.
admin.messaging().sendToDevice(registrationToken, payload)
  .then(function(response) {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch(function(error) {
    console.log('Error sending message:', error);
  });
 

sendToDevice() विधि भी केवल एक पंजीकरण टोकन के बजाय पंजीकरण टोकन की एक सरणी पास करके एक मल्टीकास्ट संदेश (जो कि कई उपकरणों के लिए एक संदेश है) भेज सकती है:

Node.js

 // These registration tokens come from the client FCM SDKs.
var registrationTokens = [
  'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...',
  // ...
  'ecupwIfBy1w:APA91bFtuMY7MktgxA3Au_Qx7cKqnf...'
];

// See the "Defining the message payload" section below for details
// on how to define a message payload.
var payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the devices corresponding to the provided
// registration tokens.
admin.messaging().sendToDevice(registrationTokens, payload)
  .then(function(response) {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch(function(error) {
    console.log('Error sending message:', error);
  });
 

sendToDevice() विधि एक वादा करता है जो एक MessagingDevicesResponse sendToDevice() ऑब्जेक्ट के साथ हल किया जाता है जिसमें FCM की प्रतिक्रिया होती है। एकल पंजीकरण टोकन या पंजीकरण टोकन की एक सरणी को पास करते समय रिटर्न प्रकार का एक ही प्रारूप होता है।

प्रमाणीकरण त्रुटि या दर सीमित करने जैसे कुछ मामले संदेश की पूरी प्रक्रिया को विफल करने का कारण बनते हैं। इन मामलों में, sendToDevice() द्वारा दिया गया वादा एक त्रुटि के साथ अस्वीकार कर दिया गया है। विवरण और रिज़ॉल्यूशन चरणों सहित त्रुटि कोड की पूरी सूची के लिए, व्यवस्थापक FCM API त्रुटियाँ देखें

एक उपकरण समूह को भेजें

डिवाइस समूह संदेश आपको एक समूह में कई डिवाइस जोड़ने की अनुमति देता है। यह विषय संदेश के समान है, लेकिन यह सुनिश्चित करने के लिए प्रमाणीकरण शामिल है कि समूह सदस्यता केवल आपके सर्वर द्वारा प्रबंधित की जाती है। उदाहरण के लिए, यदि आप विभिन्न फोन मॉडल के लिए अलग-अलग संदेश भेजना चाहते हैं, तो आपके सर्वर उपयुक्त समूहों में पंजीकरण जोड़ / हटा सकते हैं और प्रत्येक समूह को उचित संदेश भेज सकते हैं। डिवाइस समूह संदेश विषय संदेश से भिन्न होता है जिसमें यह आपके सर्वर से सीधे आपके एप्लिकेशन के बजाय डिवाइस समूहों का प्रबंधन करना शामिल है।

आप अपने ऐप सर्वर पर विरासत XMPP या HTTP प्रोटोकॉल के माध्यम से डिवाइस समूह संदेश का उपयोग कर सकते हैं। विरासत प्रोटोकॉल के आधार पर Node.js के लिए Firebase Admin SDK, डिवाइस समूह मैसेजिंग क्षमताओं को भी प्रदान करता है। एक अधिसूचना कुंजी के लिए अनुमत सदस्यों की अधिकतम संख्या 20 है।

आप डिवाइस समूह बना सकते हैं और ऐप सर्वर या एंड्रॉइड क्लाइंट के माध्यम से अधिसूचना कुंजी उत्पन्न कर सकते हैं। विवरण के लिए उपकरण समूह प्रबंधित करना देखें।

sendToDeviceGroup() विधि आपको इस उपकरण के लिए अधिसूचना कुंजी निर्दिष्ट करके डिवाइस समूह को एक संदेश भेजने की अनुमति देती है:

Node.js

 // See the "Managing device groups" link above on how to generate a
// notification key.
var notificationKey = 'some-notification-key';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
var payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device group corresponding to the provided
// notification key.
admin.messaging().sendToDeviceGroup(notificationKey, payload)
  .then(function(response) {
    // See the MessagingDeviceGroupResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch(function(error) {
    console.log('Error sending message:', error);
  });
 

sendToDeviceGroup() विधि एक वादा करता है जो एक MessagingDeviceGroupResponse sendToDeviceGroup() ऑब्जेक्ट के साथ हल होता है जिसमें FCM की प्रतिक्रिया होती है।

प्रमाणीकरण त्रुटि या दर सीमित करने जैसे कुछ मामले संदेश की पूरी प्रक्रिया को विफल करने का कारण बनते हैं। इन मामलों में, sendToDeviceGroup() द्वारा लौटाया गया वादा एक त्रुटि के साथ अस्वीकार कर दिया गया है। विवरण और रिज़ॉल्यूशन चरणों सहित त्रुटि कोड की पूरी सूची के लिए, व्यवस्थापक FCM API त्रुटियाँ देखें

संदेश पेलोड को परिभाषित करना

FCM विरासत प्रोटोकॉल पर आधारित उपरोक्त विधियाँ एक संदेश पेलोड को उनके दूसरे तर्क के रूप में स्वीकार करती हैं और अधिसूचना और डेटा संदेशों दोनों का समर्थन करती हैं। आप data और / या notification कुंजियों के साथ एक ऑब्जेक्ट बनाकर एक या दोनों संदेश प्रकार निर्दिष्ट कर सकते हैं। उदाहरण के लिए, विभिन्न प्रकार के संदेश पेलोड को परिभाषित करने का तरीका यहां दिया गया है:

अधिसूचना संदेश

 var payload = {
  notification: {
    title: '$GOOG up 1.43% on the day',
    body: '$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.'
  }
};
 

डेटा संदेश

 var payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};
 

संयुक्त संदेश

 var payload = {
  notification: {
    title: '$GOOG up 1.43% on the day',
    body: '$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  data: {
    stock: 'GOOG',
    open: '829.62',
    close: '635.67'
  }
};
 

अधिसूचना संदेश पेलोड में मान्य गुणों का पूर्वनिर्धारित उपसमुच्चय है और आपके द्वारा लक्षित मोबाइल ऑपरेटिंग सिस्टम के आधार पर थोड़ा भिन्न होता है। पूरी सूची के लिए NotificationMessagePayload का संदर्भ डॉक्स देखें।

डेटा संदेश पेलोड कुछ प्रतिबंधों के साथ कस्टम कुंजी-मूल्य जोड़े से बना है, इस तथ्य सहित कि सभी मूल्य तार होने चाहिए। प्रतिबंधों की पूरी सूची के लिए DataMessagePayload का संदर्भ डॉक्स देखें।

संदेश के विकल्प को परिभाषित करना

FCM विरासत प्रोटोकॉल पर आधारित उपरोक्त विधियाँ संदेश के लिए कुछ विकल्पों को निर्दिष्ट करने वाले एक वैकल्पिक तीसरे तर्क को स्वीकार करती हैं। उदाहरण के लिए, निम्न उदाहरण एक डिवाइस को उच्च प्राथमिकता संदेश भेजता है जो 24 घंटे के बाद समाप्त हो जाता है:

Node.js

 // This registration token comes from the client FCM SDKs.
var registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section above for details
// on how to define a message payload.
var payload = {
  notification: {
    title: 'Urgent action needed!',
    body: 'Urgent action is needed to prevent your account from being disabled!'
  }
};

// Set the message as high priority and have it expire after 24 hours.
var options = {
  priority: 'high',
  timeToLive: 60 * 60 * 24
};

// Send a message to the device corresponding to the provided
// registration token with the provided options.
admin.messaging().sendToDevice(registrationToken, payload, options)
  .then(function(response) {
    console.log('Successfully sent message:', response);
  })
  .catch(function(error) {
    console.log('Error sending message:', error);
  });
 

उपलब्ध विकल्पों की पूरी सूची के लिए MessagingOptions लिए संदर्भ डॉक्स देखें।